---
title: "Get Status"
method: POST
path: "/status/get-status"
tags: ["Status"]
---

# Get Status

`POST /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.

## Request body

- StatusRequest
  - `collection_name` string, nullable — The collection name to use. If `collection_name` is `null` or omitted, then the cumulative status across all collections will be shown.

## Response `200`

Successful Response

- StatusResponse
  - `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 `founders@zeroentropy.dev` 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.

## Other responses

- `404` — Not Found
- `422` — Validation Error

## Changes

- **2025-11-24** `c95681b13dc5` — 1 info
  - added the required property `num_indexed_bytes` to the response with the `200` status

[Change history](https://skmtc.dev/zeroentropy-ai/apis/zeroentropy-api/changes/status/get-status/post.md)

---

[API](https://skmtc.dev/zeroentropy-ai/apis/zeroentropy-api.md) · [All operations](https://skmtc.dev/zeroentropy-ai/apis/zeroentropy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zeroentropy-ai/zeroentropy-api/revisions/5ff1b24060b9/schema)