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.

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.

Authentication

AuthorizationBearer

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

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

1	from r2r import R2RClient
2
3	client = R2RClient()
4
5	# List all indices
6	indices = client.indices.list(
7	offset=0,
8	limit=10
9	)

1	{
2	"results": {
3	"indices": [
4	{
5	"index": {
6	"key": "value"
7	}
8	}
9	]
10	},
11	"total_entries": 1
12	}

Authentication

Headers

Query parameters

Response

Errors