> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Document Indexing Status

> Check the indexing progress of documents in a batch. Returns the current processing stage and chunk completion counts for each document. Poll this endpoint until `indexing_status` reaches `completed` or `error`. The status progresses through: `waiting` → `parsing` → `cleaning` → `splitting` → `indexing` → `completed`.



## OpenAPI

````yaml /en/api-reference/openapi_knowledge.json get /datasets/{dataset_id}/documents/{batch}/indexing-status
openapi: 3.0.1
info:
  title: Knowledge API
  description: >-
    API for managing knowledge bases, documents, chunks, metadata, and tags,
    including creation, retrieval, and configuration. **Note:** A single
    Knowledge Base API key has permission to operate on all visible knowledge
    bases under the same account. Please pay attention to data security.
  version: 1.0.0
servers:
  - url: '{apiBaseUrl}'
    description: The base URL for the Knowledge API.
    variables:
      apiBaseUrl:
        default: https://api.dify.ai/v1
        description: Actual base URL of the API
security:
  - ApiKeyAuth: []
tags:
  - name: Knowledge Bases
    description: >-
      Operations for managing knowledge bases, including creation,
      configuration, and retrieval.
  - name: Documents
    description: >-
      Operations for creating, updating, and managing documents within a
      knowledge base.
  - name: Chunks
    description: Operations for managing document chunks and child chunks.
  - name: Metadata
    description: >-
      Operations for managing knowledge base metadata fields and document
      metadata values.
  - name: Tags
    description: Operations for managing knowledge base tags and tag bindings.
  - name: Models
    description: Operations for retrieving available models.
  - name: Knowledge Pipeline
    description: >-
      Operations for managing and running knowledge pipelines, including
      datasource plugins and pipeline execution.
paths:
  /datasets/{dataset_id}/documents/{batch}/indexing-status:
    get:
      tags:
        - Documents
      summary: Get Document Indexing Status
      description: >-
        Check the indexing progress of documents in a batch. Returns the current
        processing stage and chunk completion counts for each document. Poll
        this endpoint until `indexing_status` reaches `completed` or `error`.
        The status progresses through: `waiting` → `parsing` → `cleaning` →
        `splitting` → `indexing` → `completed`.
      operationId: getDocumentIndexingStatus
      parameters:
        - name: dataset_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Knowledge base ID.
        - name: batch
          in: path
          required: true
          schema:
            type: string
          description: Batch ID returned from document creation.
      responses:
        '200':
          description: Indexing status for documents in the batch.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: List of indexing status entries.
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Document identifier.
                        indexing_status:
                          type: string
                          description: >-
                            Current indexing status: `waiting`, `parsing`,
                            `cleaning`, `splitting`, `indexing`, `completed`, or
                            `error`.
                        processing_started_at:
                          type: number
                          description: Unix timestamp when processing started.
                        parsing_completed_at:
                          type: number
                          description: Unix timestamp when parsing completed.
                        cleaning_completed_at:
                          type: number
                          description: Unix timestamp when cleaning completed.
                        splitting_completed_at:
                          type: number
                          description: Unix timestamp when splitting completed.
                        completed_at:
                          type: number
                          description: Unix timestamp when indexing completed.
                        paused_at:
                          type: number
                          nullable: true
                          description: >-
                            Timestamp when indexing was paused. `null` if not
                            paused.
                        error:
                          type: string
                          nullable: true
                          description: >-
                            Error message if indexing failed. `null` if no
                            error.
                        stopped_at:
                          type: number
                          nullable: true
                          description: >-
                            Timestamp when indexing was stopped. `null` if not
                            stopped.
                        completed_segments:
                          type: integer
                          description: Number of chunks that have been indexed.
                        total_segments:
                          type: integer
                          description: Total number of chunks to be indexed.
              examples:
                success:
                  summary: Response Example
                  value:
                    data:
                      - id: a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac
                        indexing_status: completed
                        processing_started_at: 1741267200
                        parsing_completed_at: 1741267200
                        cleaning_completed_at: 1741267200
                        splitting_completed_at: 1741267200
                        completed_at: 1741267200
                        paused_at: null
                        error: null
                        stopped_at: null
                        completed_segments: 5
                        total_segments: 5
        '404':
          description: '`not_found` : Knowledge base not found. / Documents not found.'
          content:
            application/json:
              examples:
                dataset_not_found:
                  summary: not_found
                  value:
                    status: 404
                    code: not_found
                    message: Dataset not found.
                documents_not_found:
                  summary: not_found
                  value:
                    status: 404
                    code: not_found
                    message: Documents not found.
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API_KEY
      description: >-
        API Key authentication. For all API requests, include your API Key in
        the `Authorization` HTTP Header, prefixed with `Bearer `. Example:
        `Authorization: Bearer {API_KEY}`. **Strongly recommend storing your API
        Key on the server-side, not shared or stored on the client-side, to
        avoid possible API-Key leakage that can lead to serious consequences.**

````