Document Indexes

List

Beta
GET
Used to retrieve a list of Document Indexes.

Query parameters

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.
statusenumOptional

The current status of the document index

  • ACTIVE - Active
  • ARCHIVED - Archived

Response

This endpoint returns an object
count
integerOptional
next
stringOptional
previous
stringOptional
results
list of objectsOptional
GET
$curl https://api.vellum.ai/v1/document-indexes \
> -H "X_API_KEY: <apiKey>"
Response
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 "status": "ACTIVE",
13 "environment": "DEVELOPMENT"
14 }
15 ]
16}