Workflow 应用 API

本文档由 AI 自动翻译。如有任何不准确之处，请参考英文原版。

Workflow 应用运行在 workflow 模式下，每次调用执行一次已发布的工作流并返回其输出。调用之间不保留会话状态，每次运行都相互独立。

认证方式、基础 URL，以及按终端用户区分数据的 user 字段，详见快速开始和终端用户身份。

运行工作流

无论选择哪种模式，响应都会携带两个 ID：task_id 用于控制运行中的任务，workflow_run_id 用于标识运行结束后持久保存的记录。

停止工作流任务：通过 task_id 取消运行中的任务。仅适用于流式返回；阻塞式返回的响应送达时，任务已执行完毕，无法取消。
流式获取工作流事件：连接中断或运行暂停后，从 workflow_run_id 恢复事件流。传入 include_state_snapshot=true 可先重放已执行节点的状态，传入 continue_on_pause=true 可在多次人工介入暂停间保持流连接。

当运行到达提交方式为 WebApp 的人工介入节点时，可通过 API 完成这次暂停的处理：

监听暂停事件

运行的事件流会推送 human_input_required 事件，其中携带 form_token 和本次运行的 workflow_run_id，随后以 workflow_paused 事件结束。

获取表单

使用 form_token 调用获取人工介入表单，加载表单内容。

提交填写结果

通过提交人工介入表单发送接收者的填写内容。提交后运行恢复执行。

继续跟踪事件流

使用暂停时事件流中的 workflow_run_id，调用流式获取工作流事件打开新的事件流，跟踪剩余事件，直到运行结束。

带文件的表单提交与完整事件序列，详见人工介入流程指南。

如需逐节点的事件，应流式跟踪运行本身，而非查看日志：新发起的运行以流式返回调用执行工作流，已在执行中的运行使用流式获取工作流事件。

上传文件：上传图片、文档、音频或视频文件，运行工作流时在文件类型的输入变量中以返回的 id 作为 upload_file_id 传入。文件仅限上传的终端用户使用。
获取终端用户信息：根据终端用户 ID（例如上传文件响应中的 created_by）查询该用户的详细信息。