Skip to main content
POST

授权

Authorization
string
header
必填

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

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

请求头

X-Trace-Id
string

与请求体字段 trace_id 相同,优先读取。

X-Trace-Session-Id
string

与请求体字段 trace_session_id 相同,优先读取。

查询参数

trace_id
string

与请求体字段 trace_id 相同,在请求头之后读取。

trace_session_id
string

与请求体字段 trace_session_id 相同,在请求头之后读取。

请求体

application/json
inputs
object
必填

应用输入变量的值,以变量名为键。请按照目标环境当前部署版本中定义的输入变量传值。

单文件变量传入一个文件对象,文件列表变量传入文件对象数组;文件对象的结构与 files 中的条目相同。

user
string
必填

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

response_mode
enum<string>
默认值:blocking

指定响应如何返回。

  • streaming:运行每产出一个事件就立即返回,适合快速回复以外的所有场景。
  • blocking:运行结束后一次性返回一个响应。
可用选项:
streaming,
blocking
files
object[] | null

传给工作流的文件。本地文件需先通过 上传文件 上传,再把返回的 id 作为 upload_file_id 引用,并设置 transfer_method: local_file。

能否接受这些文件,取决于工作流自身的文件设置,例如允许的类型和数量。工作流不接受文件时,这些条目会被忽略。

trace_id
string

追踪标识,会传递到可观测性数据中。可使用字母、数字、连字符和下划线,最长 128 个字符。不符合的值直接跳过,不会报错。

trace_session_id
string

追踪会话标识,会传递到可观测性数据中,去除首尾空白后长度为 1 到 200 个字符。

Required string length: 1 - 200

响应

内容类型和结构取决于请求中的 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>

此次工作流运行的 ID。

data
object