Skip to content

List Indexes

GET
/api/v1/indexes

List all vector indexes.

Args: service: Index management service (injected)

Returns: List of all indexes with their details

Raises: HTTPException: 500 for server errors

Successful Response

IndexListResponseModel

API response model for listing indexes.

object
indexes
required
Indexes
Array<object>
IndexInfoModel

API model for vector index information.

object
index_name
required
Index Name
string
model_name
required
Model Name
string
index_type
required
Index Type
string
Allowed values: ivfflat hnsw
row_count
required
Row Count
integer
size_bytes
required
Size Bytes
integer
size_pretty
required
Size Pretty
string
parameters
required
Parameters
object
key
additional properties
integer
scan_count
Scan Count
integer
0
total_count
required
Total Count
integer