Skip to main content
POST
/
datasets
/
{dataset_id}
/
pipeline
/
run
curl --request POST \
  --url https://{api_base_url}/datasets/{dataset_id}/pipeline/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": {},
  "datasource_type": "local_file",
  "datasource_info_list": [
    {
      "reference": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "quarterly-report.pdf"
    }
  ],
  "start_node_id": "1719288585006",
  "is_published": true,
  "response_mode": "blocking"
}
'
"<string>"
{
  "status": 400,
  "code": "invalid_param",
  "message": "Pipeline not found"
}
{
  "status": 403,
  "code": "forbidden",
  "message": "Dataset api access is not enabled."
}
{
  "status": 404,
  "code": "not_found",
  "message": "Dataset not found."
}
{
  "status": 500,
  "code": "pipeline_run_error",
  "message": "Pipeline execution failed: connection timeout"
}

Authorizations

​
Authorization
string
header
required

API Key 认证。对于所有 API 请求，请在 Authorization HTTP 头中包含您的 API Key，并加上 Bearer 前缀。示例：Authorization: Bearer {API_KEY}。强烈建议将 API Key 存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。缺少或无效的 API Key 会返回 HTTP 401，错误码为 unauthorized。

Path Parameters

​
dataset_id
string<uuid>
required

知识库 ID。

Body

application/json
​
inputs
object
required

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

​
datasource_type
enum<string>
required

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

Available options:
local_file,
online_document,
website_crawl,
online_drive
​
datasource_info_list
(Local File · object | Online Document · object | Website Crawl · object | Online Drive · object)[]
required

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

​
start_node_id
string
required

流水线开始执行的数据源节点 ID。

​
is_published
boolean
required

运行流水线的已发布版本还是草稿版本。true 运行最新已发布版本；false 运行当前草稿（适用于测试未发布的更改）。

​
response_mode
enum<string>
required

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

Available options:
streaming,
blocking

Response

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

服务器发送事件流。每行格式为 data: {JSON}\n\n。主要事件：workflow_started（执行开始）、node_started / node_finished（逐节点进度，包含 node_id、node_type、status、inputs、outputs）、workflow_finished（最终结果，包含 status、outputs、total_tokens、elapsed_time）、ping（心跳保活）。

Last modified on July 9, 2026