Skip to content

Create index on table column

POST
/dataset-tables/{tableId}/indexes

Create a new index on a column. Returns an operation for tracking progress.

tableId
required

Unique identifier of the table to retrieve

string

Unique identifier of the table to retrieve

object
indexName
required

Unique index name within the table (1-255 characters)

string
>= 1 characters <= 255 characters
columnName
required

Name of the column to index

string
>= 1 characters
indexType
required

Type of index to create (btree, ivf_flat, ivf_pq)

string
Allowed values: btree ivf_pq ivf_hnsw_pq ivf_hnsw_sq inverted

Index creation started

object
operationId
required

Unique identifier for the operation

string
operationType
required

Type of operation (compact, build_index, etc.)

string
targetType
required

Type of target resource (table, index)

string
targetId
required

ID of the target resource

string
description
required

Human-readable description of the operation

string
status
required

Current operation status (pending, running, succeeded, failed)

string
Allowed values: pending running completed failed cancelled
progressPercent
required

Progress percentage (0-100)

number
progressMessage

Human-readable progress message

string
error

Error details if operation failed

object
code
required

Error code

string
message
required

Human-readable error message

string
createdAt
required

When the operation was created

string
startedAt

When the operation started running

string
completedAt

When the operation completed

string

Bad Request - Validation error or invalid input

object
error
required
string
code
string
details
nullable
retryable
boolean

Unauthorized - Authentication required or invalid token

object
error
required
string
code
string
details
nullable
retryable
boolean

Forbidden - Insufficient permissions

object
error
required
string
code
string
details
nullable
retryable
boolean

Not Found - Resource does not exist

object
error
required
string
code
string
details
nullable
retryable
boolean