工作流运行
执行工作流
适用于:Workflow。
运行应用已发布的工作流并返回其输出,可以是单次 blocking 响应,也可以是 streaming 的 Server-Sent Events 流。需要已发布的工作流。
应用运行在部署环境中时,改用 部署环境专用接口。
POST
授权
每个请求都通过 API 密钥认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API 密钥,知识库接口使用知识库 API 密钥(快速开始)。
API 密钥应保存在服务端,切勿嵌入客户端代码。缺失或无效的密钥会返回 HTTP 401(unauthorized)。
请求体
application/json
工作流输入变量的键值对。变量名称和类型可从 获取应用参数 响应中的 user_input_form 字段获取。
文件类型变量的值为文件对象数组,包含 type、transfer_method 以及 url 或 upload_file_id。
终端用户标识,由你的应用定义,需在应用内唯一。用于限定数据访问范围:工作流运行及其文件仅对携带相同 user 的后续请求可见。参见 终端用户身份。
文件列表。适用于需要将文件与文本组合输入的场景,仅在模型支持 Vision 能力时可用。要附加本地文件,请先通过 上传文件 上传,然后将返回的 id 作为 upload_file_id,并设置 transfer_method: local_file。
- Option 1
- Option 2
响应
请求成功。内容类型和结构取决于请求中的 response_mode 参数。
- 如果
response_mode为blocking,返回application/json和WorkflowBlockingResponse对象。 - 如果
response_mode为streaming,返回text/event-stream和ChunkWorkflowEvent对象流。