Skip to main content
post/datasets/{dataset_id}/pipeline/run
Request example
Response
post/datasets/{dataset_id}/pipeline/run

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。

Body

application/json
datasource_info_listobject[]required#
待处理的数据源对象列表。条目结构取决于 datasource_type。
datasource_typeenum<string>required#
数据源类型。决定 datasource_info_list 中条目所需的字段。
Options:local_fileonline_documentwebsite_crawlonline_drive
inputsobjectrequired#
流水线输入变量的键值对,对应工作流中定义的流水线变量。如果流水线没有输入变量,传 {}。
is_publishedbooleanrequired#
是否运行流水线的已发布版本,而非当前草稿。运行草稿可测试未发布的更改。
response_modeenum<string>required#
流水线执行的响应模式。streaming 返回服务器发送事件流,blocking 等待并返回完整结果。
Options:streamingblocking
start_node_idstringrequired#
开始执行的节点 ID,来自 获取数据源插件列表。

Responses

流水线执行结果。格式取决于 response_mode:流式返回 text/event-stream,阻塞返回完整的 JSON 结果。