Document Indexes

Retrieve

Beta
GET
https://api.vellum.ai/v1/document-indexes/:id
Used to retrieve a Document Index given its ID or name.

Path parameters

id
string
Either the Document Index's ID or its unique name

Response

This endpoint return an object.
id
string
created
datetime
label
string
A human-readable label for the document index
name
string
A name that uniquely identifies this index within its workspace
indexing_config
map from strings to any
Configuration representing how documents should be indexed
status
optional enum

The current status of the document index

  • ACTIVE - Active
  • ARCHIVED - Archived
Allowed values: ACTIVEARCHIVED
environment
optional enum

The environment this document index is used in

  • DEVELOPMENT - Development
  • STAGING - Staging
  • PRODUCTION - Production
Allowed values: DEVELOPMENTSTAGINGPRODUCTION
GET
/v1/document-indexes/:id
curl https://api.vellum.ai/v1/document-indexes/id \
-H "X_API_KEY: <apiKey>"
Response
{
"id": "id",
"created": "2024-01-15T09:30:00Z",
"label": "label",
"name": "name",
"indexing_config": {
"indexing_config": {
"key": "value"
}
},
"status": "ACTIVE",
"environment": "DEVELOPMENT"
}