Documents

Get Document Indexing Status

Changed on

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.

get/datasets/{dataset_id}/documents/{batch}/indexing-status

Request

  • Base URL
    https://api.dify.ai/v1
  • URL
    https://api.dify.ai/v1/datasets/{dataset_id}/documents/{batch}/indexing-status
  • Auth
    HTTP bearer

Path parameters

dataset_idstring uuid required

Knowledge base ID, from List Knowledge Bases. For a scoped key, copy the ID from the Dify URL.

batchstring required

Batch ID returned when you create or update a document.

Response

Indexing status for documents in the batch.

Changes

  • 1647da477789Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status