> ## Documentation Index > Fetch the complete documentation index at: https://dify-6c0370d8-fix-template-upload-size-guidance.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # 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`. ## OpenAPI ````yaml /en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{batch}/indexing-status openapi: 3.0.1 info: description: >- REST API for Dify applications and knowledge bases. Application endpoints authenticate with an app API key; knowledge endpoints authenticate with a dataset API key. title: Dify Service API version: 1.0.0 servers: - description: >- Base URL of the Dify Service API. For self-hosted deployments, replace it with your own API base URL. url: https://{api_base_url} variables: api_base_url: default: api.dify.ai/v1 description: Host and path of the API base URL, without the `https://` prefix. security: - ApiKeyAuth: [] tags: - description: Operations related to chat messages and interactions. name: Chat Messages - description: File upload and preview operations. name: Files - description: Operations related to end user information. name: End Users - description: User feedback operations. name: Feedback - description: Operations related to managing conversations. name: Conversations - description: Text-to-Speech and Speech-to-Text operations. name: Audio - description: Operations to retrieve application settings and information. name: Applications - description: Operations related to managing annotations for direct replies. name: Annotations - description: Endpoints for resuming paused workflows that require human input. name: Human Input - description: Operations for executing and managing workflows. name: Workflow Runs - description: Operations related to text generation and completion. name: Completion Messages - description: >- Operations for managing knowledge bases, including creation, configuration, and retrieval. name: Knowledge Bases - description: >- Operations for creating, updating, and managing documents within a knowledge base. name: Documents - description: Operations for managing document chunks and child chunks. name: Chunks - description: >- Operations for managing knowledge base metadata fields and document metadata values. name: Metadata - description: Operations for managing knowledge base tags and tag bindings. name: Tags - description: Operations for retrieving available models. name: Models - description: >- Operations for managing and running knowledge pipelines, including datasource plugins and pipeline execution. name: Knowledge Pipeline paths: /datasets/{dataset_id}/documents/{batch}/indexing-status: get: tags: - Documents summary: Get Document Indexing Status description: >- 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`. operationId: getDocumentIndexingStatus parameters: - description: >- Knowledge base ID. From [List Knowledge Bases](/en/api-reference/knowledge-bases/list-knowledge-bases). in: path name: dataset_id required: true schema: format: uuid type: string - description: Batch ID returned when you create or update a document. in: path name: batch required: true schema: type: string responses: '200': content: application/json: examples: success: summary: Response Example value: data: - cleaning_completed_at: 1741267200 completed_at: 1741267200 completed_segments: 5 error: null id: a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac indexing_status: completed parsing_completed_at: 1741267200 paused_at: null processing_started_at: 1741267200 splitting_completed_at: 1741267200 stopped_at: null total_segments: 5 schema: properties: data: description: List of indexing status entries. items: properties: cleaning_completed_at: description: Unix timestamp when cleaning completed. nullable: true type: number completed_at: description: Unix timestamp when indexing completed. nullable: true type: number completed_segments: description: Number of chunks that have been indexed. type: integer error: description: >- Error message if indexing failed. `null` if no error. nullable: true type: string id: description: Document identifier. type: string indexing_status: description: >- Current indexing status: `waiting`, `parsing`, `cleaning`, `splitting`, `indexing`, `completed`, or `error`. type: string parsing_completed_at: description: Unix timestamp when parsing completed. nullable: true type: number paused_at: description: >- Timestamp when indexing was paused. `null` if not paused. nullable: true type: number processing_started_at: description: Unix timestamp when processing started. nullable: true type: number splitting_completed_at: description: Unix timestamp when splitting completed. nullable: true type: number stopped_at: description: >- Timestamp when indexing was stopped. `null` if not stopped. nullable: true type: number total_segments: description: Total number of chunks to be indexed. type: integer type: object type: array type: object description: Indexing status for documents in the batch. '403': content: application/json: examples: forbidden: summary: forbidden (api access) value: code: forbidden message: Dataset api access is not enabled. status: 403 description: '`forbidden` : Knowledge base API access is not enabled.' '404': content: application/json: examples: dataset_not_found: summary: not_found value: code: not_found message: Dataset not found. status: 404 documents_not_found: summary: not_found value: code: not_found message: Documents not found. status: 404 description: |- - `not_found` : Knowledge base not found. - `not_found` : Documents not found. components: securitySchemes: ApiKeyAuth: bearerFormat: API_KEY description: >- Every request authenticates with an API key: `Authorization: Bearer {API_KEY}`. App endpoints take an app API key; knowledge endpoints take a knowledge base API key ([Get Started](/en/api-reference/guides/get-started)). Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP `401` (`unauthorized`). scheme: bearer type: http ````