POST
/
status
/
get-status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
collection_name
string | null

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

Response

200 - application/json
num_documents
integer
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_failed_documents
integer
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_documents
integer
required

The number of documents that are currently indexed.

num_indexing_documents
integer
required

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

num_parsing_documents
integer
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.