异步执行工作流组件
更新时间：2025-12-22
POST
https://qianfan.baidubce.com/v2/tools/workflow/async/run
该接口用于创建一个异步的工作流组件任务，并返回execute_id等，用于获取工作流的执行结果。
权限说明
调用本文API，需使用API Key鉴权方式。使用API Key鉴权调用API流程，具体调用流程，请查看认证鉴权。
请求参数
Headers 参数
除公共头域外，无其它特殊头域
Body 参数
component
string
组件id
必选
parameters
object {6}
必选
显示子属性
隐藏子属性
_sys_file_urls
object
文件URL映射。对应画布中开始节点的系统参数fileUrls，格式为{"文件名": "文件路径"}，例如{"xxx.pdf": "http:///"}。
可选
显示子属性
隐藏子属性
_sys_end_user_id
string
终端用户id。对应画布中开始节点的系统参数end_user_id。
可选
_sys_chat_history
array
对话历史记录。对应画布中开始节点的系统参数chatHistory。
可选
显示子属性
隐藏子属性
items
object {2}
显示子属性
隐藏子属性
role
string
对话角色
可选
content
string
内容
可选
_sys_origin_query
string
用户查询内容。对应画布中开始节点的系统参数rawQuery。
必选
input_variable_name
object
自定义输入参数。
可选
显示子属性
隐藏子属性
_sys_conversation_id
string
会话标识ID。对应画布中开始节点的系统参数conversation_id，可通过新建会话接口创建。当前仅透传该字段，并不获取里面的上下文信息。
可选
version
string
组件版本号。如果不指定version，默认使用组件最新版本。如果要指定version，可以使用版本号。
可选
请求结构
POST v2/tools/workflow/async/run HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: Bearer <API Key>
Content-Type: application/json
{
"component": "abc-123",
"parameters": {
"_sys_origin_query": "hello"
}
}示例代码
请求示例
curl https://qianfan.baidubce.com/v2/tools/workflow/async/run \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <API Key>" \
-d '{
"component": "c-***-182753fb4733",
"parameters": {
"_sys_origin_query": "hello"
}
}'返回响应
Headers 参数
除公共头域外，无其它特殊头域
返回参数
response
oneOf {2}
多选一且必需“只能”符合其中一个
可选
显示子属性
隐藏子属性
response
object {6}
正确响应参数
显示子属性
隐藏子属性
conversation_id
string
对话ID
必选
message_id
string
一问或一答的信息ID
必选
trace_id
string
正确调用时标识ID
必选
user_id
string
用户ID，用于计费依赖
必选
end_user_id
string
终端用户ID
可选
response
object {3}
错误响应参数
显示子属性
隐藏子属性
request_id
string
错误标识 id
必选
code
string
错误代码，当发生异常时返回。
可选
message
string
错误消息，当发生异常时返回。
可选
JSON
{
"execute_id": "2023451c-***-f777e25c6085",
"conversation_id": "5712cde4-***-1e86d49a5a5b",
"message_id": "5a3696cc-***-2578da9261b5",
"trace_id": "5a3696cc-***-2578da9261b5",
"user_id": "47996032-***-0dc1409ec54f"
}JSON
{
"code": "InternalServerError",
"message": "Internal Server Error",
"request_id": "be996bff-***-a7cec3dfd715"
}