Dify Octri Demo
GET/datasets/{dataset_id}/documents/{batch}/indexing-status

Get Document 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.

2 parameters
dataset_idstringrequired
Knowledge base ID, from [List Knowledge Bases](/en/api-reference/knowledge-bases/list-knowledge-bases). For a scoped key, [copy the ID from the Dify URL](/en/api-reference/guides/knowledge#knowledge-base-id).
batchstringrequired
Batch ID returned when you create or update a document.

3 status codes
200Indexing status for documents in the batch.
dataarray<object>optional
List of indexing status entries.
403- `forbidden` : Knowledge base API access is not enabled. - `forbidden` : The API key is scoped to specific knowledge bases, and this knowledge base is not one of them.

One documented failure

  • forbidden

    Dataset api access is not enabled.

    forbidden (api access)

404- `not_found` : Knowledge base not found. - `not_found` : Documents not found.

One documented failure

  • not_found

    Dataset not found.

    not_found

Error handling

A 403 is returned: - forbidden : Knowledge base API access is not enabled.

  • forbidden : The API key is scoped to specific knowledge bases, and this knowledge base is not one of them. A 404 is returned: - not_found : Knowledge base not found.
  • not_found : Documents not found.