v1

latestOpenAPI 3.1.02026-07-1255227258.8 KB
documents

Create Document

On ingest, the document goes through a series of steps before it is ready for retrieval. Each step is reflected in the status of the document which can be one of [pending, partitioning, partitioned, refined, chunked, indexed, summary_indexed, keyword_indexed, ready, failed]. The document is available for retrieval once it is in ready state. The summary index step can take a few seconds. You can optionally use the document for retrieval once it is in indexed state. However the summary will only be available once the state has changed to summary_indexed or ready.

post/documents

Response

Successful Response

statusstring required
idstring uuid required
created_atstring date-time required
updated_atstring date-time required
namestring required
metadataobject required
partitionstring required
chunk_countinteger nullable
external_idstring nullable
page_countnumber nullable