Document Indexes

Partial Update

PATCH
Used to partial update a Document Index given its ID.

Path parameters

idstringRequired
A UUID string identifying this document index.

Request

This endpoint expects an object.
label
stringOptional
A human-readable label for the document index
status
enumOptional

The current status of the document index

  • ACTIVE - Active
  • ARCHIVED - Archived
Allowed values: ACTIVEARCHIVED
environment
enumOptional

The environment this document index is used in

  • DEVELOPMENT - Development
  • STAGING - Staging
  • PRODUCTION - Production
Allowed values: DEVELOPMENTSTAGINGPRODUCTION

Response

This endpoint returns 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
enumOptional

The current status of the document index

  • ACTIVE - Active
  • ARCHIVED - Archived
Allowed values: ACTIVEARCHIVED
environment
enumOptional

The environment this document index is used in

  • DEVELOPMENT - Development
  • STAGING - Staging
  • PRODUCTION - Production
Allowed values: DEVELOPMENTSTAGINGPRODUCTION
PATCH
1curl -X PATCH https://api.vellum.ai/v1/document-indexes/id \
2     -H "X_API_KEY: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200
Updated
1{
2  "id": "id",
3  "created": "2024-01-15T09:30:00Z",
4  "label": "label",
5  "name": "name",
6  "indexing_config": {
7    "indexing_config": {
8      "key": "value"
9    }
10  },
11  "status": "ACTIVE",
12  "environment": "DEVELOPMENT"
13}
Built with