> ## 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.

# 获取文档嵌入状态（进度）

> 检查批量文档的索引进度。返回每个文档的当前处理阶段和分段完成计数。请轮询此接口直到 `indexing_status` 变为 `completed` 或 `error`。状态按以下顺序推进：`waiting` → `parsing` → `cleaning` → `splitting` → `indexing` → `completed`。



## OpenAPI

````yaml /zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{batch}/indexing-status
openapi: 3.0.1
info:
  title: Dify 服务 API
  description: 用于 Dify 应用与知识库的 REST API。应用类接口使用应用 API 密钥认证，知识库类接口使用知识库 API 密钥认证。
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: Dify 服务 API 的基础 URL。自部署时，替换为你的 API 基础 URL。
    variables:
      api_base_url:
        default: api.dify.ai/v1
        description: API 基础 URL 的主机与路径，不含 `https://` 前缀。
security:
  - ApiKeyAuth: []
tags:
  - name: 对话消息
    description: 与聊天消息和交互相关的操作。
  - name: 文件操作
    description: 文件上传和预览操作。
  - name: 终端用户
    description: 终端用户信息相关操作。
  - name: 消息反馈
    description: 用户反馈操作。
  - name: 会话管理
    description: 与管理会话相关的操作。
  - name: 语音与文字转换
    description: 文字转语音和语音转文字操作。
  - name: 应用配置
    description: 获取应用设置和信息的操作。
  - name: 标注管理
    description: 与管理标注直接回复相关的操作。
  - name: 人工介入
    description: 暂停等待人工输入的工作流恢复操作。
  - name: 工作流运行
    description: 用于执行和管理工作流的操作。
  - name: 文本生成消息
    description: 文本生成相关操作。
  - name: 知识库
    description: 用于管理知识库的操作，包括创建、配置和检索。
  - name: 文档
    description: 用于在知识库中创建、更新和管理文档的操作。
  - name: 分段
    description: 用于管理分段和子分段的操作。
  - name: 元数据
    description: 用于管理知识库元数据字段和文档元数据值的操作。
  - name: 标签
    description: 用于管理知识库标签和标签绑定的操作。
  - name: 模型
    description: 用于获取可用模型的操作。
  - name: 知识流水线
    description: 用于管理和运行知识流水线的操作，包括数据源插件和流水线执行。
paths:
  /datasets/{dataset_id}/documents/{batch}/indexing-status:
    get:
      tags:
        - 文档
      summary: 获取文档嵌入状态（进度）
      description: >-
        检查批量文档的索引进度。返回每个文档的当前处理阶段和分段完成计数。请轮询此接口直到 `indexing_status` 变为
        `completed` 或 `error`。状态按以下顺序推进：`waiting` → `parsing` → `cleaning` →
        `splitting` → `indexing` → `completed`。
      operationId: getDocumentIndexingStatus
      parameters:
        - name: dataset_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: 知识库 ID。
        - name: batch
          in: path
          required: true
          schema:
            type: string
          description: 创建文档时返回的批次 ID。
      responses:
        '200':
          description: 批次中文档的索引状态。
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: 文档标识符。
                        indexing_status:
                          type: string
                          description: >-
                            当前索引状态：`waiting`、`parsing`、`cleaning`、`splitting`、`indexing`、`completed`
                            或 `error`。
                        processing_started_at:
                          type: number
                          description: 处理开始的 Unix 时间戳。
                        parsing_completed_at:
                          type: number
                          description: 解析完成的 Unix 时间戳。
                        cleaning_completed_at:
                          type: number
                          description: 清洗完成的 Unix 时间戳。
                        splitting_completed_at:
                          type: number
                          description: 拆分完成的 Unix 时间戳。
                        completed_at:
                          type: number
                          description: 索引完成的 Unix 时间戳。
                        paused_at:
                          type: number
                          nullable: true
                          description: 索引暂停的时间戳。未暂停时为 `null`。
                        error:
                          type: string
                          nullable: true
                          description: 索引失败时的错误信息。无错误时为 `null`。
                        stopped_at:
                          type: number
                          nullable: true
                          description: 索引停止的时间戳。未停止时为 `null`。
                        completed_segments:
                          type: integer
                          description: 已索引的分段数。
                        total_segments:
                          type: integer
                          description: 待索引的分段总数。
                    description: 索引状态条目列表。
              examples:
                success:
                  summary: 响应示例
                  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
        '403':
          description: '`forbidden` : 该知识库未启用 API 访问。'
          content:
            application/json:
              examples:
                forbidden:
                  summary: forbidden (api access)
                  value:
                    status: 403
                    code: forbidden
                    message: Dataset api access is not enabled.
        '404':
          description: '`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 认证。对于所有 API 请求，请在 `Authorization` HTTP 头中包含您的 API Key，并加上
        `Bearer ` 前缀。示例：`Authorization: Bearer {API_KEY}`。**强烈建议将 API Key
        存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。**缺少或无效的 API Key 会返回 HTTP
        `401`，错误码为 `unauthorized`。

````