List Document Indexes | Vellum

Used to retrieve a list of Document Indexes.

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

orderingstringOptional

Which field to use when ordering the results.

searchstringOptional

Search for document indices by name or label

statusenumOptional

Filter down to only document indices that have a status matching the status specified

Allowed values:

countintegerOptional

nextstringOptionalformat: "uri"

previousstringOptionalformat: "uri"

resultslist of objectsOptional

1	from vellum import Vellum
2
3	client = Vellum(
4	api_key="YOUR_API_KEY",
5	)
6	client.document_indexes.list()

1	{
2	"count": 123,
3	"next": "http://api.example.org/accounts/?offset=400&limit=100",
4	"previous": "http://api.example.org/accounts/?offset=200&limit=100",
5	"results": [
6	{
7	"id": "id",
8	"created": "2024-01-15T09:30:00Z",
9	"label": "label",
10	"name": "name",
11	"indexing_config": {
12	"vectorizer": {
13	"model_name": "text-embedding-3-small",
14	"config": {}
15	}
16	},
17	"status": "ACTIVE"
18	}
19	]
20	}