Retrieve Document Index — Vellum

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	"status": "ACTIVE",
7	"environment": "DEVELOPMENT",
8	"indexing_config": {
9	"vectorizer": {
10	"model_name": "hkunlp/instructor-xl",
11	"config": {
12	"instruction_domain": "instruction_domain",
13	"instruction_query_text_type": "instruction_query_text_type",
14	"instruction_document_text_type": "instruction_document_text_type"
15	}
16	},
17	"chunking": {
18	"chunker_name": "token-overlapping-window-chunker"
19	}
20	}
21	}

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