Workflow 应用 API

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

​

运行工作流

• 执行工作流：使用提供的输入变量，执行应用当前已发布的工作流。 流式返回时，节点执行过程中会实时推送事件；阻塞式返回时，运行结束后才返回结果。
• 按 ID 执行工作流：执行指定的已发布版本，其 workflow_id 来自此前的运行响应或运行详情查询结果。Dify Enterprise 3.4.1 起可用。

​

跟踪与控制运行

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

• 停止工作流任务：通过 task_id 取消运行中的任务。仅适用于流式返回；阻塞式返回的响应送达时，任务已执行完毕，无法取消。

​

查看历史运行

• 获取工作流执行情况：根据 workflow_run_id 查询某次运行的状态与输出。
• 获取工作流日志：返回运行级别的汇总信息（状态、token 用量、步骤数、耗时），而非逐节点的执行日志；可按关键词、状态、时间范围或触发运行的用户筛选。

如需逐节点的事件，新发起的运行以流式返回调用 执行工作流，而非查看日志。

​

处理文件

• 上传文件：上传图片、文档、音频或视频文件，运行工作流时在文件类型的输入变量中以返回的 id 作为 upload_file_id 传入。文件仅限上传的终端用户使用。

​

语音转写与合成

• 语音转文字：将上传的音频文件（MP3、M4A、WAV、AMR 或 MPGA，最大 30 MB）转写为文字，让终端用户用语音代替打字提供输入值。
• 文字转语音：将工作流的文本输出合成为语音。

​

获取应用信息与配置

• 获取应用基本信息：返回应用的名称、描述、标签和模式。
• 获取应用参数：返回调用需在 inputs 中传入的字段（名称、类型、默认值），以及应用的功能开关，可据此构建请求或客户端界面。
• 获取应用元数据：返回工具图标等配置元数据。
• 获取应用 Web 应用设置：返回 Web 应用的站点配置、主题和自定义选项。