查询工作流异步运行结果

请求地址

权限

listRunHistory
确保调用该接口使用的访问令牌开通了 listRunHistory 权限，详细信息参考鉴权方式。

接口说明

工作流异步运行后，查看执行结果。

Authorization

Bearer $Access_Token

用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌，详细信息，参考准备工作。

Content-Type

application/json

解释请求正文的方式。

workflow_id

String

可选

73505836754923***

待执行的 Workflow ID，此工作流应已发布。
进入 Workflow 编排页面，在页面 URL 中，workflow 参数后的数字就是 Workflow ID。例如 https://www.coze.com/work_flow?space_id=42463***&workflow_id=73505836754923***，Workflow ID 为 73505836754923***。

execute_id

String

可选

743104097880585****

工作流执行 ID。调用接口执行工作流，如果选择异步执行工作流，响应信息中会返回 execute_id。

code

Long

0

调用状态码。0 表示调用成功，其他值表示调用失败，你可以通过 msg 字段判断详细的错误原因。

msg

String

“”

状态信息。API 调用失败时可通过此字段查看详细错误信息。
状态码为 0 时，msg 默认为空。

data

Array of WorkflowExecuteHistory

\

异步工作流的执行结果。
每次只能查询一个异步事件的执行结果，所以此数组只有一个对象。

detail

Object of ResponseDetail

{“logid”:“20241210152726467C48D89D6DB2****”}

本次请求的执行详情。

execute_id

String

743104097880585****

工作流执行 ID。

execute_status

String

Success

执行状态。

• Success：执行成功。
• Running：执行中。
• Fail：执行失败。

bot_id

String

75049216555930****

执行工作流时指定的 Agent ID。返回 0 表示未指定智能体 ID。

connector_id

String

1024

智能体的发布渠道 ID，默认仅显示 Agent as API 渠道，渠道 ID 为 1024。

connector_uid

String

123

用户 UID，执行工作流时通过 ext 字段指定的 user_id。如果未指定，则返回 Token 申请人的扣子用户 UID。

run_mode

Integer

0

工作流的运行方式：

• 0：同步运行。
• 1：流式运行。
• 2：异步运行。

output

String

{"Output":"{\"content_type\":1,\"data\":\"来找姐姐有什么事呀\",\"original_result\":null,\"type_for_model\":2}"}

工作流的输出，通常为 JSON 序列化字符串，也有可能是非 JSON 结构的字符串。
工作流输出的内容包括：

• 输出节点的输出。
• 结束节点的输出。在扣子编程代码中，结束节点的输出是通过键（key）Output 来标识。

工作流输出的结构如下所示：

{
  "Output": "结束节点的输出内容",
  "输出节点_1": "输出节点_1的输出内容",
  "输出节点_2": "输出节点_2的输出内容"
}

create_time

Long

1730174063

工作流运行开始时间，Unixtime 时间戳格式，单位为秒。

update_time

Long

1730174063

工作流的恢复运行时间，Unixtime 时间戳格式，单位为秒。

node_execute_status

JSON Map

\

输出节点的运行情况。字段的格式为：key:node_status,value:map[node_title]*nodeExecuteStatus{}。
key为节点的名称，如果节点运行了多次，则会随机生成节点名称。

error_code

String

“”

执行失败调用状态码。0 表示调用成功。其他值表示调用失败。你可以通过 error_message 字段判断详细的错误原因。

debug_url

String

https://www.coze.cn/work_flow?execute_id=743104097880585****&space_id=730976060439760****&workflow_id=742963539464539****

工作流试运行调试页面。访问此页面可查看每个工作流节点的运行结果、输入输出等信息。

usage

Object of Usage

{“input_count”:50,“token_count”:150,“output_count”:100}

本次 API 调用消耗的 Token 数量。
此处大模型返回的消耗 Token 仅供参考，以火山引擎账单实际为准。

is_output_trimmed

Boolean

false

标识工作流的输出内容是否因过大而不完整。

• true：输出内容因过大被截断。
• false：输出内容完整。

logid

String

20241210152726467C48D89D6DB2****

本次请求的日志 ID。如果遇到异常报错场景，且反复重试仍然报错，可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持。

error_message

String

“”

状态信息。API 调用失败时可通过此字段查看详细错误信息。

interrupt_data

Object of Interrupt

{“data”:“{"content_type":"text","content":"请输入您的姓名"}”,“type”:2,“event_id”:“740483198820252***”,“required_parameters”:{“name”:{“type”:“string”,“required”:true}}}

中断事件的详细信息，包含中断控制内容、中断类型和事件 ID 等信息。

node_id

String

node_123

工作流中的节点 ID。

is_finish

Boolean

true

工作流中的节点是否已经运行结束。

loop_index

Long

2

当前节点在循环节点中的循环次数。
第一次循环时值为 0。

batch_index

Long

3

当前节点在批处理节点中的执行次数。
第一次执行时值为 0。

update_time

Long

1730174063

工作流上次运行的时间，采用 Unix 时间戳格式，单位为秒。

sub_execute_id

String

743104097880585****

子工作流执行的 ID。

node_execute_uuid

String

78923456777*****

节点每次执行的 ID，用于追踪和识别工作流中特定节点的单次执行情况。

input_count

Integer

50

输入内容所消耗的 Token 数，包含对话上下文、系统提示词、用户当前输入等所有输入类的 Token 消耗。

output_count

Integer

100

大模型输出的内容所消耗的 Token 数。

token_count

Integer

150

本次 API 调用消耗的 Token 总量，包括输入和输出两部分的消耗。

data

String

{"content_type":"text","content":"[{\"type\":\"string\",\"name\":\"img\",\"required\":true,\"assistType\":2}]"}

中断控制内容，用于在工作流中断时传递控制信息。当工作流需要用户输入或执行特定操作时，通过此字段传递相关信息。

type

Integer

2

工作流中断类型，调用恢复运行工作流 API 恢复运行时应回传此字段。
枚举值：

• 6：端插件触发中断。
• 2：问答节点触发中断。
• 5：输入节点触发中断。
• 7：OAuth 插件触发中断。

event_id

String

740483198820252***

工作流中断事件 ID，调用恢复运行工作流 API 恢复运行时应回传此字段。

required_parameters

JSON Map

{ “img”: { “required”: true, “type”: “image” } }

工作流中断时需要补充的参数信息，采用键值对（key-value）结构，其中 key 为输入节点对应的参数名称，value 为该参数的定义信息（包含类型、是否必填等属性）。

type

String

string

该参数的类型。

items

Object of OpenAPIParameter

{“type”:“image”}

当参数类型为 array 时，该字段用于定义数组元素的子类型。

required

Boolean

true

标识输入参数是否为必填项。

• true：该参数为必填项。
• false：该参数为可选项。

properties

JSON Map

{ “arr_obj_num”: { “required”: false, “type”: “number” } }

当参数类型为 object时，该字段用于定义对象类型的子参数信息，采用键值对（key-value）结构，其中 key 为子参数的名称，value 为该子参数的定义信息（包含类型、是否必填等属性）。

description

String

上传的图片。

该参数的描述信息。

default_value

String

-

该参数配置的默认值。

logid

String

20241210152726467C48D89D6DB2****

本次请求的日志 ID。如果遇到异常报错场景，且反复重试仍然报错，可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持。