API & SDKsIndices

List Vector Indices

List existing vector similarity search indices with pagination support.

Returns details about each index including:

  • Name and table name
  • Indexing method and parameters
  • Size and row count
  • Creation timestamp and last updated
  • Performance statistics (if available)

The response can be filtered using the filter_by parameter to narrow down results based on table name, index method, or other attributes.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-API-KeystringRequired

Query parameters

offsetintegerOptional>=0Defaults to 0

Specifies the number of objects to skip. Defaults to 0.

limitintegerOptional>=1<=1000Defaults to 100

Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100.

Response

Successful Response

resultsobject
total_entriesinteger

Errors