---
title: "Get Document Indexing Status"
method: GET
path: "/datasets/{dataset_id}/documents/{batch}/indexing-status"
tags: ["Documents"]
---

# Get Document Indexing Status

`GET /datasets/{dataset_id}/documents/{batch}/indexing-status`

Returns indexing progress for every document in a batch: the current stage and chunk completion counts. Poll until each `indexing_status` reaches `completed` or `error`. Status advances through `waiting` → `parsing` → `cleaning` → `splitting` → `indexing` → `completed`.

## Path parameters

- `dataset_id` string, uuid, required
- `batch` string, required

## Response `200`

Indexing status for documents in the batch.

- object
  - `data` object[] — List of indexing status entries.
    - `id` string — Document identifier.
    - `indexing_status` string — Current indexing status: `waiting`, `parsing`, `cleaning`, `splitting`, `indexing`, `completed`, or `error`.
    - `processing_started_at` number, nullable — Unix timestamp when processing started.
    - `parsing_completed_at` number, nullable — Unix timestamp when parsing completed.
    - `cleaning_completed_at` number, nullable — Unix timestamp when cleaning completed.
    - `splitting_completed_at` number, nullable — Unix timestamp when splitting completed.
    - `completed_at` number, nullable — Unix timestamp when indexing completed.
    - `paused_at` number, nullable — Timestamp when indexing was paused. `null` if not paused.
    - `error` string, nullable — Error message if indexing failed. `null` if no error.
    - `stopped_at` number, nullable — Timestamp when indexing was stopped. `null` if not stopped.
    - `completed_segments` integer — Number of chunks that have been indexed.
    - `total_segments` integer — Total number of chunks to be indexed.

## Other responses

- `403` — `forbidden` : Knowledge base API access is not enabled.
- `404` — - `not_found` : Knowledge base not found. - `not_found` : Documents not found.

---

[API](https://skmtc.net/langgenius/apis/dify-service-api.md) · [All operations](https://skmtc.net/langgenius/apis/dify-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/langgenius/dify-service-api/versions/361dc12484f4/schema)