执行工作流

适用于：Workflow。

运行应用已发布的工作流并返回其输出，可以是单次 blocking 响应，也可以是 streaming 的 Server-Sent Events 流。需要已发布的工作流。

POST /workflows/run

cURL

streaming_example

curl --request POST \
  --url https://{api_base_url}/workflows/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": {
    "query": "Summarize this text: The quick brown fox jumps over the lazy dog."
  },
  "response_mode": "streaming",
  "user": "user_workflow_123"
}
'

200

blockingResponse

{
  "task_id": "c3800678-a077-43df-a102-53f23ed20b88",
  "workflow_run_id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156",
  "data": {
    "id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156",
    "workflow_id": "7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345",
    "status": "succeeded",
    "outputs": {
      "result": "Bonjour le monde"
    },
    "error": null,
    "elapsed_time": 1.23,
    "total_tokens": 150,
    "total_steps": 3,
    "created_at": 1705407629,
    "finished_at": 1705407630
  }
}

Authorizations

Authorization · string · header · required

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

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

Body

application/json

inputs · object · required

工作流输入变量的键值对。变量名称和类型可从 获取应用参数 响应中的 user_input_form 字段获取。

文件类型变量的值为文件对象数组，包含 type、transfer_method 以及 url 或 upload_file_id。

Show child attributes

user · string · required

终端用户标识，由你的应用定义，需在应用内唯一。用于限定数据访问范围：工作流运行及其文件仅对携带相同 user 的后续请求可见。参见 终端用户身份。

response_mode · enum<string>

响应模式。使用 blocking 获取同步响应（Cloudflare 超时时间为 100 s），使用 streaming 获取服务器发送事件。未指定时默认为阻塞模式。

Available options: streaming, blocking

files · object[] | null

文件列表。适用于需要将文件与文本组合输入的场景，仅在模型支持 Vision 能力时可用。要附加本地文件，请先通过 上传文件 上传，然后将返回的 id 作为 upload_file_id，并设置 transfer_method: local_file。

Option 1

Option 2

Show child attributes

Response

200

application/json

请求成功。内容类型和结构取决于请求中的 response_mode 参数。

• 如果 response_mode 为 blocking，返回 application/json 和 WorkflowBlockingResponse 对象。
• 如果 response_mode 为 streaming，返回 text/event-stream 和 ChunkWorkflowEvent 对象流。

task_id · string<uuid>

进行中的执行任务 ID。配合 停止工作流任务 使用以取消运行中的工作流。仅在执行期间有效。

workflow_run_id · string<uuid>

此工作流运行记录的持久化标识符。配合 获取工作流运行详情 使用以在执行后获取结果。

data · object

Show child attributes