Sign in

v16

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-032765158.3 KB
Status

Get Status

Gets the current indexing status across all documents.

If a collection name is passed in, it will get the indexing status of only the documents within that collection. Otherwise, it will show the cumulative status across all of your collections.

A 404 Not Found status code will be returned, if a collection name was provided, but it does not exist.

post/status/get-status

Request body

collection_namestring nullable

The collection name to use. If collection_name is null or omitted, then the cumulative status across all collections will be shown.

Response

Successful Response

num_documentsinteger required

The total number of documents, regardless of their status. It is guaranteed that the sum of all of the other fields, is this number.

num_parsing_documentsinteger required

The number of documents that are being parsed. This refers files of the type PDF, DOCX, PPT, etc, whose images are being processed, or are waiting to be processed, by our OCR system.

num_indexing_documentsinteger required

The number of documents being indexed. Indexing occurs only after the document has finished parsing.

num_indexed_documentsinteger required

The number of documents that are currently indexed.

num_failed_documentsinteger required

The number of failed documents. Failures can occur during either parsing, or indexing. It can occur if the file is malformed or incomplete. If you believe that the file is formatted correctly, please contact us at founders@zeroentropy.dev to assist.

num_indexed_bytesinteger required

The total number of bytes used by documents that are currently indexed. Measured as UTF-8 bytes. For PDF/DOCX/PPT/etc, this is of the OCR'ed text.