API ReferenceIndexes
API Reference

Indexes

Create, list, and delete indexes on cached tables. Supports sorted indexes for range queries and BM25 full-text indexes for keyword search.

List indexes across tables in a database

GET/v1/indexes

List all indexes in the database identified by the required X-Database-Id header, paginated. Optional filters narrow by connection, schema, table, or index type.

Query parameters

  • connection_id string — Filter to one connection
  • schema string — Filter by schema name
  • table string — Filter by table name
  • index_type string — Filter by index type
  • limit integer — Max indexes per page
  • cursor string — Pagination cursor

Headers

  • X-Database-Id stringrequired. Database to scope to (required)

Response 200 — Indexes listed

  • count integerrequired. Min: 0
  • has_more booleanrequired
  • indexes IndexEntryResponse[] — required
  • limit integerrequired. Min: 0
  • next_cursor string,null
{
  "count": 0,
  "has_more": true,
  "indexes": [
    {
      "columns": [
        "string"
      ],
      "created_at": "2026-01-01T00:00:00Z",
      "index_name": "string",
      "index_type": "string",
      "metric": "string",
      "source_column": "string",
      "status": "ready",
      "updated_at": "2026-01-01T00:00:00Z",
      "connection_id": "string",
      "schema_name": "string",
      "table_name": "string"
    }
  ],
  "limit": 0,
  "next_cursor": "string"
}

Errors

StatusDescription
400Missing X-Database-Id or bad cursor
404Database not found
500Internal server error