异步执行工作流Agent
更新时间:2025-12-19
POST
https://qianfan.baidubce.com/v2/app/chatflow/async/run
创建一个异步工作流Agent任务,返回execute_id用于后续查询工作流Agent的异步执行结果。
权限说明
调用本文API,需使用API Key鉴权方式。使用API Key鉴权调用API流程,具体调用流程,请查看认证鉴权。
请求参数
Headers 参数
除公共头域外,无其它特殊头域
Body 参数
parameters
object {6}
调用传参,具体见下文对象定义。
必选
显示子属性
隐藏子属性
_sys_origin_query
string
用户输入,对应工作流Agent画布中开始节点的系统参数rawQuery。
必选
_sys_file_urls
object
文件路径,对应工作流Agent画布中开始节点的系统参数fileUrls。
格式:{"文件名": "文件路径"}
可选
显示子属性
隐藏子属性
_sys_end_user_id
string
终端用户ID,对应工作流Agent画布中开始节点的系统参数end_user_id。
可选
_sys_chat_history
array
应用使用的累计对话历史,对应工作流Agent画布中开始节点的系统参数chatHistory。
可选
显示子属性
隐藏子属性
items
object {2}
显示子属性
隐藏子属性
role
string
对话角色。
可选
content
string
对话内容。
可选
input_variable_name
object {0}
用户自定义添加的参数。对应工作流Agent画布中开始节点用户新增的参数。
例如:
Plain Text
"parameters": {
"_sys_origin_query": "今天有什么新闻",
"custom_count": 4 //input_variable_name 自定义参数
}
可选
显示子属性
隐藏子属性
暂无参数
version
string
应用版本,默认使用应用最新版本。
例如:"version": "1",
可选
interrupt_id
string
信息收集节点的中断ID,对应工作流Agent画布中信息收集节点,将app_id和interrupt_id写入_sys_origin_query即可实现信息收集节点后续的异步流程。
可选
请求结构
POST /v2/app/chatflow/async/run HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: Bearer <API Key>
Content-Type: application/json
{
"app_id": "4ed8a003-****-4f67-a8ec-df1523d2f7dd",
"parameters": {
"_sys_origin_query": "帮我查看北京今日天气情况",
"_sys_conversation_id": "bc3800ca-****-4dfb-9d84-3c931c89a218",
}
}
示例代码
基础调用
curl -X POST "https://qianfan.baidubce.com/v2/app/chatflow/async/run" \
-H "Authorization: Bearer bce-v3/ALTAK-tnrnBt********OuDwEyx1/cf9f5ccb6717264fc93bd3c713300542be00bc85" \
-H "Content-Type: application/json" \
-d '{
"app_id": "4ed8a003-****-4f67-a8ec-df1523d2f7dd",
"parameters": {
"_sys_origin_query": "帮我查看北京今日天气情况",
"_sys_conversation_id": "bc3800ca-****-4dfb-9d84-3c931c89a218"
}
}'
返回响应
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": "cbb44132-****-44d5-9541-1956a0c59ab1",
"conversation_id": "8003093d-****-4894-966e-d7dae13478c9",
"message_id": "837f7b14-e5b8-****-b32e-07a5890ac043",
"trace_id": "837f7b14-e5b8-****-b32e-07a5890ac043",
"user_id": "47996032-9ed5-****-adaa-0dc1409ec54f"
}
json
{
"request_id": "0c171df1-ac1a-4683-9f79-14068caa2926",
"code": 3200001,
"message": "Component version not found"
}
