Document Indexes

Create Document Index

Beta
POST
Creates a new document index.

Request

This endpoint expects an object.
label
stringRequired
A human-readable label for the document index
name
stringRequired
A name that uniquely identifies this index within its workspace
indexing_config
objectRequired
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
copy_documents_from_index_id
stringOptional
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
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
object
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