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
Built with