跳转到主要内容
POST

授权

Authorization
string
header
必填

每个请求都通过 API 密钥认证：Authorization: Bearer {API_KEY}。应用接口使用应用 API 密钥，知识库接口使用知识库 API 密钥（快速开始）。

API 密钥应保存在服务端，切勿嵌入客户端代码。缺失或无效的密钥会返回 HTTP 401（unauthorized）。

路径参数

dataset_id
string<uuid>
必填

知识库 ID，通过 获取知识库列表 获取。使用限定范围的密钥时，从 Dify 页面 URL 复制 ID。

请求体

application/json
inputs
object
必填

流水线输入变量的键值对，对应工作流中定义的流水线变量。如果流水线没有输入变量，传 {}。

datasource_type
enum<string>
必填

数据源类型。决定 datasource_info_list 中条目所需的字段。

可用选项:
local_file,
online_document,
website_crawl,
online_drive
datasource_info_list
(本地文件 · object | 在线文档 · object | 网站爬取 · object | 在线存储 · object)[]
必填

待处理的数据源对象列表。条目结构取决于 datasource_type。

start_node_id
string
必填

开始执行的节点 ID，来自 获取数据源插件列表。

is_published
boolean
必填

是否运行流水线的已发布版本，而非当前草稿。运行草稿可测试未发布的更改。

response_mode
enum<string>
必填

流水线执行的响应模式。streaming 返回服务器发送事件流，blocking 等待并返回完整结果。

可用选项:
streaming,
blocking

响应

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

Server-Sent Events 流。当 response_mode 为 streaming 时返回；线路格式参见 SSE 流式传输。

主要事件：

  • workflow_started：执行开始
  • node_started / node_finished：逐节点进度，包含 node_id、node_type、status、inputs、outputs
  • workflow_finished：最终结果，包含 status、outputs、total_tokens、elapsed_time
  • ping：心跳保活