List Document Indexes

Beta

GET

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

status"ACTIVE" or "ARCHIVED"Optional

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

Allowed values: ACTIVEARCHIVED

This endpoint returns an object.

countintegerOptional

nextstringOptional

previousstringOptional

resultslist of objectsOptional

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-multilingual-embedding-002",
14	"config": {
15	"project_id": "project_id",
16	"region": "region"
17	}
18	}
19	},
20	"status": "ACTIVE",
21	"environment": "DEVELOPMENT"
22	}
23	]
24	}

1	curl https://api.vellum.ai/v1/document-indexes \
2	-H "X_API_KEY: <apiKey>"