Retrieve Document Index

Beta

GET

Used to retrieve a Document Index given its ID or name.

idstringRequired

Either the Document Index’s ID or its unique name

This endpoint returns an object.

idstring

createddatetime

labelstring

A human-readable label for the document index

namestring

A name that uniquely identifies this index within its workspace

indexing_configobject

status"ACTIVE" or "ARCHIVED"Optional

Allowed values: ACTIVEARCHIVED

The current status of the document index

environmentenumOptional

Allowed values: DEVELOPMENTSTAGINGPRODUCTION

The environment this document index is used in

1	{
2	"id": "id",
3	"created": "2024-01-15T09:30:00Z",
4	"label": "label",
5	"name": "name",
6	"indexing_config": {
7	"vectorizer": {
8	"model_name": "text-multilingual-embedding-002",
9	"config": {
10	"project_id": "project_id",
11	"region": "region"
12	}
13	},
14	"chunking": {
15	"chunker_name": "token-overlapping-window-chunker"
16	}
17	},
18	"status": "ACTIVE",
19	"environment": "DEVELOPMENT"
20	}

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