文档首页/ 智能体平台 Versatile/ API参考/ API/ 工作流/ 调用工作流应用
更新时间：2025-09-15 GMT+08:00
查看PDF
分享

调用工作流应用

功能介绍

该接口用于运行场景化应用，支持在指定的项目、工作流和对话上下文中执行工作流逻辑。接口支持流式响应模式，可以根据需要返回增量执行结果，适用于实时交互场景。

适用场景：

  • 在项目中运行预定义的工作流。

  • 支持调试模式和发布模式，适用于不同开发和生产环境。

  • 支持流式响应，适用于需要实时反馈的场景（如聊天机器人、实时数据分析等）。

URI

POST /v1/{project_id}/workflows/{workflow_id}/conversations/{conversation_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

当前租户项目ID。

获取方法请参考获取项目ID。

约束限制：

不涉及。

取值范围：

由英文，数字，“-”，“_”组成，不超过64位字符。

默认取值：

不涉及。

workflow_id

是

String

参数解释：

工作流应用的ID。

获取方式：

  1. 进入Versatile智能体平台。

  2. 在左侧导航选择“开发中心 > 应用管理 > 工作流应用”。

  3. 在待复制ID的工作流应用卡片上，单击“▪▪▪ > 复制ID”。

约束限制：

不涉及。

取值范围：

由英文，数字，“-”，“_”组成，不超过64位字符。

默认取值：

不涉及。

conversation_id

是

String

参数解释：

会话ID，每个会话的唯一标识符，可将会话ID设置为任意值，使用标准UUID格式。

  1. 进入Versatile智能体平台。

  2. 在左侧导航选择“开发中心 > 应用管理 > 工作流应用”。

  3. 在待复制调用路径的工作流应用卡片上，单击“▪▪▪ > 调用路径”。

  4. 在弹出的“调用路径”页面，单击“复制路径”即可获取调用路径。其中，conversation_id参数为会话ID，唯一标识每个会话的标识符，可将会话ID设置为任意值，使用标准UUID格式。

约束限制：

不涉及。

取值范围：

由英文，数字，“-”，“_”组成，不超过64位字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

workspace_id

否

String

参数解释：

工作空间ID，用于标识特定的工作空间。

获取方法请参考获取工作空间ID。

约束限制：

不涉及。

取值范围：

由英文，数字，“-”，“_”组成，不超过64位字符。

默认取值：

不涉及。

version

否

String

参数解释：

发布版本号。

获取方式：

  1. 进入Versatile智能体平台。

  2. 在左侧导航选择“开发中心 > 应用管理 > 工作流应用”。

  3. 选择需要查找的工作流应用。

  4. 在工作流界面右上角，单击“发布历史”，获取发布版本号。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Invoke-Mode

否

String

参数解释：

该参数用于标识工作流应用运行的模式。

  • X-Invoke-Mode的值为debug时，工作流应用的运行模式为调试模式。调试模式会生成日志、详细的执行步骤，便于排查问题。

  • X-Invoke-Mode的值为published时，工作流应用的运行模式为发布模式。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

stream

否

Boolean

参数解释：

是否开启流式调用。

  • 当stream为true时，服务器以流式方式逐步返回结果，适合需要实时反馈的场景。

  • 当stream为false时，服务器在处理完成后一次性返回结果，适合处理较小数据或不需要实时反馈的场景。

约束限制：

不涉及。

取值范围：

  • true：开启。

  • false：不开启。

默认取值：

不涉及。
表4 请求Body参数

参数

是否必选

参数类型

描述

inputs

是

Map<String,Object>

参数解释：

用户提出的问题，作为运行工作流的输入，与工作流开始节点输入参数对应。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

plugin_configs

否

Array of PluginConfig objects

参数解释：

插件配置信息。

约束限制：

不涉及。

取值范围：

当工作流关联插件节点，并且插件是“用户级鉴权”时，需要配置对应的鉴权信息。其他情况该参数无需传值，plugin_configs传空数组。

默认取值：

不涉及。
表5 PluginConfig

参数

是否必选

参数类型

描述

plugin_id

否

String

参数解释：

插件ID。

获取方式：

  1. 进入Versatile智能体平台。

  2. 在左侧导航选择“开发中心 > 组件库 > 我的插件”。

  3. 在待复制ID的插件卡片上，单击“▪▪▪ > 复制ID”。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

config

否

Map<String,String>

参数解释：

配置插件信息。当工作流关联插件节点，并且插件是“用户级鉴权”时，需要在此配置对应的鉴权信息。例如，针对如下插件，config可以配成：{"key2": "value"}。其他情况该参数无需传值，plugin_configs传空数组即可。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

event

Map<String,Object>

参数解释：

工作流最终输出内容表示工作流运行。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

data

Array of Message objects

参数解释：

工作流助手回复内容。例如，提问器节点问题消息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

status

Map<String,Object>

参数解释：

状态信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

start_time

Long

参数解释：

开始时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

end_time

Long

参数解释：

结束时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表7 Message

参数

参数类型

描述

role

String

参数解释：

会话角色。

约束限制：

不涉及。

取值范围：

  • user：用户输入的消息，包括提示词和上下文信息。

  • assistant：模型生成的回复内容。

默认取值：

不涉及。

content

String

参数解释：

会话内容。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

{
  "method" : "POST",
  "url" : "https://api.example.com/v1/12345/workflows/67890/conversations/67890",
  "headers" : {
    "Content-Type" : "application/json",
    "X-Auth-Token" : "MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...",
    "stream" : true
  },
  "body" : {
    "inputs" : {
      "query" : "你好"
    },
    "plugin_configs" : [ {
      "plugin_id" : "xxxxxxxxx",
      "config" : {
        "key" : "value"
      }
    } ]
  }
}

响应示例

状态码：200

成功响应。

{
  "event" : "workflow_finished",
  "data" : {
    "status" : {
      "code" : 1,
      "desc" : "succeeded"
    },
    "outputs" : {
      "responseContent" : "《朝花夕拾》是关于某篇文章、某个人物或某个主题，欢迎继续提问。"
    },
    "start_time" : 1757729064202,
    "end_time" : 1757729120126
  }
}

状态码

状态码

描述

200

成功响应。

错误码

请参见错误码。

父主题： 工作流

相关文档