Client SDKDocument Indexes

Retrieve Document Index

Beta
Used to retrieve a Document Index given its ID or name.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired
Either the Document Index's ID or its unique name

Headers

X-API-VersionstringOptional

Query parameters

mask_indexing_configbooleanOptional
Whether to mask the indexing configuration in the response

Response

idstringformat: "uuid"
createdstringformat: "date-time"
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
statusenum or null
The current status of the document index * `ACTIVE` - Active * `ARCHIVED` - Archived
Allowed values: