Skip to main content
patch/datasets/{dataset_id}/documents/status/{action}
Request example
Response
patch/datasets/{dataset_id}/documents/status/{action}

Authorization

Authorizationstringheaderrequired#

每个请求都通过 API Key 认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API Key,知识库接口使用知识库 API Key(快速开始)。

API Key 应保存在服务端,切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401(unauthorized)。

Path parameters

dataset_idstringrequired#
知识库 ID,通过 获取知识库列表 获取。使用限定范围的密钥时,从 Dify 页面 URL 复制 ID。
actionenum<string>required#
enable 启用文档以供检索,disable 停用,archive 移入归档,un_archive 从归档中恢复。
Options:enabledisablearchiveun_archive

Body

application/json
document_idsstring[]required#
要更新的文档 ID。文档 ID 从 获取知识库的文档列表 获取。

Responses

application/json
文档更新成功。
resultstring#
操作结果。