Skip to main content
POST
/
status
/
get-status
Get Status
curl --request POST \
  --url https://api.zeroentropy.dev/v1/status/get-status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collection_name": "<string>"
}
'
{
  "num_documents": 123,
  "num_parsing_documents": 123,
  "num_indexing_documents": 123,
  "num_indexed_documents": 123,
  "num_failed_documents": 123,
  "num_indexed_bytes": 123
}

Authorizations

​
Authorization
string
header
required

The Authorization header must be provided in the format Bearer <your-api-key>.

You can get your API Key at the Dashboard!

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

Successful Response

​
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_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.

​
num_indexing_documents
integer
required

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

​
num_indexed_documents
integer
required

The number of documents that are currently indexed.

​
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 [email protected] to assist.

​
num_indexed_bytes
integer
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.