Client SDKDocument IndexesBeta

Create Document Index

Creates a new document index.

Headers

X_API_KEYstringRequired

Request

This endpoint expects an object.
labelstringRequired>=1 character<=150 characters

A human-readable label for the document index

namestringRequired>=1 character<=150 characters

A name that uniquely identifies this index within its workspace

indexing_configobjectRequired
statusenumOptional

The current status of the document index

  • ACTIVE - Active
  • ARCHIVED - Archived
Allowed values:
copy_documents_from_index_idstringOptionalformat: "uuid"

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

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

  • ACTIVE - Active
  • ARCHIVED - Archived
Allowed values: