Create Document Index

Beta

POST

Creates a new document index.

Request

This endpoint expects an object.

labelstringRequired

A human-readable label for the document index

namestringRequired

A name that uniquely identifies this index within its workspace

indexing_configobjectRequired

status"ACTIVE" or "ARCHIVED"Optional

Allowed values: ACTIVEARCHIVED

The current status of the document index

ACTIVE - Active
ARCHIVED - Archived

environmentenumOptional

Allowed values: DEVELOPMENTSTAGINGPRODUCTION

The environment this document index is used in

DEVELOPMENT - Development
STAGING - Staging
PRODUCTION - Production

copy_documents_from_index_idstringOptional

Optionally specify the id of a document index from which you’d like to copy and re-index its documents into this newly created index

Response

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

ACTIVE - Active
ARCHIVED - Archived

environmentenumOptional

Allowed values: DEVELOPMENTSTAGINGPRODUCTION

The environment this document index is used in

DEVELOPMENT - Development
STAGING - Staging
PRODUCTION - Production

POST

1 curl -X POST https://api.vellum.ai/v1/document-indexes \
2      -H "X_API_KEY: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "label": "My Document Index",
6   "name": "my-document-index",
7   "indexing_config": {
8     "vectorizer": {
9       "model_name": "text-multilingual-embedding-002",
10       "config": {
11         "project_id": "project_id",
12         "region": "region"
13       }
14     },
15     "chunking": {
16       "chunker_name": "token-overlapping-window-chunker"
17     }
18   }
19 }'

200Successful

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 }