Update Document Index | Vellum

Used to partial update a Document Index given its ID or name.

idstringRequired

Either the Document Index’s ID or its unique name

This endpoint expects an object.

labelstringOptional>=1 character<=150 characters

A human-readable label for the document index

statusenumOptional

The current status of the document index

Allowed values:

idstringformat: "uuid"

createddatetime

labelstring<=150 characters

A human-readable label for the document index

namestring<=150 characters

A name that uniquely identifies this index within its workspace

indexing_configobject

statusenumOptional

The current status of the document index

Allowed values:

1	curl -X PATCH https://api.vellum.ai/v1/document-indexes/id \
2	-H "X_API_KEY: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

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-embedding-3-small",
9	"config": {}
10	},
11	"chunking": {
12	"chunker_name": "reducto-chunker"
13	}
14	},
15	"status": "ACTIVE"
16	}