恢复运行工作流

请求地址

权限

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

接口说明

恢复运行工作流。

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***。

event_id

String

必选

74048319882025***

工作流执行中断事件 ID。你可以从执行工作流 的响应信息中获得中断事件 ID。

resume_data

String

必选

杭州，2024-08-20

恢复执行时，用户对智能体指定问题的回复。
如果是问答节点或输入节点导致的中断，回复中应包含对应节点中的必选参数，否则工作流会再次中断并提问。
如果要传入 Image 等类型的文件，可以调用上传文件API 获取 file_id，在调用此 API 时在 resume_data 中以序列化之后的 JSON 格式传入 file_id。例如 “resume_data” : "{\"file_id\": \"1456234***\"}"。

interrupt_type

Integer

必选

2

工作流执行中断的类型，用于标识导致工作流中断的具体原因，你可以从执行工作流 的响应信息中获得中断事件的中断类型。枚举值：

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

code

Long

0

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

msg

String

“”

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

data

String

{"output":"杭州当天的天气为小雨。"}

同步运行时返回的工作流执行结果，通常为 JSON 序列化字符串，部分场景下可能返回非 JSON 结构的字符串。

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 仅供参考，以火山引擎账单实际为准。

interrupt_data

Object of Interrupt

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

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

execute_id

String

743104097880585****

异步运行时的事件 ID。如果执行工作流为异步运行时，本 API 也为异步运行，响应信息中会返回 execute_id。
调用查询异步执行结果 API 时需要传入此 ID，查询工作流的执行状态或结果。

detail

Object of ResponseDetail

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

包含本次请求的日志信息，用于问题排查和技术支持。

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 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持。