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

# 批量更新文档状态

> 批量启用、禁用、归档或取消归档多个文档。



## OpenAPI

````yaml /zh/api-reference/openapi_knowledge.json patch /datasets/{dataset_id}/documents/status/{action}
openapi: 3.0.1
info:
  title: 知识库 API
  description: >-
    用于管理知识库、文档、分段、元数据和标签的 API，包括创建、检索和配置操作。**注意：**单个知识库 API
    密钥有权操作同一账户下所有可见的知识库。请注意数据安全。
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: Knowledge 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: 用于管理和运行知识流水线的操作，包括数据源插件和流水线执行。
paths:
  /datasets/{dataset_id}/documents/status/{action}:
    patch:
      tags:
        - 文档
      summary: 批量更新文档状态
      description: 批量启用、禁用、归档或取消归档多个文档。
      operationId: batchUpdateDocumentStatus
      parameters:
        - name: dataset_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: 知识库 ID。
        - name: action
          in: path
          required: true
          schema:
            type: string
            enum:
              - enable
              - disable
              - archive
              - un_archive
          description: '`enable` 启用，`disable` 停用，`archive` 归档，`un_archive` 从归档中恢复。'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - document_ids
              properties:
                document_ids:
                  type: array
                  items:
                    type: string
                  description: 要更新的文档 ID 列表。
      responses:
        '200':
          description: 文档更新成功。
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    description: 操作结果。
              examples:
                success:
                  summary: 响应示例
                  value:
                    result: success
        '400':
          description: '`invalid_action` : 无效的操作。'
          content:
            application/json:
              examples:
                invalid_action:
                  summary: invalid_action
                  value:
                    status: 400
                    code: invalid_action
                    message: Invalid action.
        '403':
          description: '`forbidden` : 权限不足。'
          content:
            application/json:
              examples:
                forbidden:
                  summary: forbidden
                  value:
                    status: 403
                    code: forbidden
                    message: Insufficient permissions.
        '404':
          description: '`not_found` : 知识库未找到。'
          content:
            application/json:
              examples:
                not_found:
                  summary: not_found
                  value:
                    status: 404
                    code: not_found
                    message: Dataset 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 泄漏导致严重后果。**

````