更新时间:2026-04-15 GMT+08:00
分享

调用运行时 - InvokeRuntime

功能介绍

该接口用于运行场景化应用,支持在指定的智能体、工作流中执行。接口支持流式响应模式,可以根据需要返回增量执行结果,适用于实时交互场景。

适用场景:

  • 在项目中运行预定义的工作流/智能体。

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

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

URI

POST /agent/{runtime_name}/invocations

表1 路径参数

参数

是否必选

参数类型

描述

runtime_name

String

参数解释

需要执行的运行时名称。

获取方法:

方式一

  1. 进入AgentArts智能体开发平台,在左侧菜单栏选择“智能体管理”,选择“工作流”或者“智能体”。

  2. 鼠标移动至待运行的智能体/工作流卡片上,单击“调用路径”。

  3. 在弹出的卡片中,复制运行时名称,名称为“jiuwen-”开头 。

方式二

  1. 进入AgentArts智能体开发平台,在左侧菜单栏选择“智能体管理”,选择“工作流”或者“智能体”。

  2. 鼠标移动至待运行的智能体/工作流卡片上,单击“复制ID”。

  3. 在左侧菜单栏选择“智能体运行时”。

  4. 在搜索框内输入智能体/工作流ID,单击搜索。结果即为运行时名称信息。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

参数解释

鉴权参数。

获取方式:

1.进入AgentArts智能体开发平台,在左侧菜单栏选择“智能体管理”,选择“工作流”或者“智能体”。

2.鼠标移动至待运行的智能体/工作流卡片上,单击“调用路径”。

3.在弹出的卡片中,复制运行时名称,名称为“jiuwen-”开头 。

4.在左侧导航,选择“智能体运行时”。

5.在搜索框内输入获取的运行时名称,单击搜索。

6.单击运行时名称,进入详情页面,在“权限与访问控制”区域,单击“URN”。

7.在基本信息页面获取API Key值并复制。

8.在API Key值前加上“Bearer ”。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Invoke-Mode

String

参数解释

该参数用于标识运行时运行的模式。

约束限制

不涉及。

取值范围

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

  • X-Invoke-Mode的值为published时,运行模式为发布模式。

默认取值

published。

x-hw-agentarts-session-id

String

参数解释

会话ID,每个会话的唯一标识符。用户可将会话ID设置为任意字符串,例如“123e4567e89b12d3a456426614174000”,无需在其他地方获取。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

X-Request-Id

String

参数解释

调用链ID,每个请求的唯一标识符。用于日志中跟踪整个请求的调用链路。用户可将调用链ID设置为任意字符串,例如“123e4567e89b12d3a4564266141740”,无需在其他地方获取。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

Content-Type

String

参数解释

发送的实体的MIME类型。

约束限制

不涉及。

取值范围

不涉及。

默认取值

application/json。

表3 请求Body参数

参数

是否必选

参数类型

描述

query

String

参数解释

用户请求的问题。

调用单智能体/多智能体选择此参数,必填。

约束限制

不涉及

取值范围

不涉及。

默认取值

不涉及。

inputs

Map<String,Object>

参数解释

在调用工作流接口时,inputs对象中的字段(Key)并非API预留的固定字段,而是取决于您在工作流“开始节点”中定义的变量名

约束限制

为确保工作流正常运行,请遵循以下原则判断哪些变量需要传入:

配置必填项:若在“开始节点”中将某个变量设为“必填”,则调用API时必须包含该字段,且取值不能为空(若后续节点未引用,可填写任意占位值)。

逻辑引用项:若某个变量在“开始节点”中设为“可选”,但其后的任何一个节点(如大模型节点、工具节点)引用了该变量,则调用API时必

须传入该字段,否则会导致引用该变量的节点执行失败。

可选忽略项:只有在“开始节点”中设为“可选”,且后续所有节点均未引用的情况下,该字段才可以在调用时省略。

取值范围

不涉及。

默认取值

不涉及。

plugin_configs

Array of PluginConfig objects

参数解释

插件配置信息。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

表4 PluginConfig

参数

是否必选

参数类型

描述

plugin_id

String

参数解释

插件ID。

获取方式:

  1. 进入AgentArts智能体开发平台。

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

  3. 鼠标移动至待复制ID的插件卡片上,单击“更多 > 复制ID”。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

config

Map<String,String>

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

event

Map<String,Object>

参数解释

运行时最终输出内容表示运行时结果。

取值范围

不涉及。

data

data object

参数解释

运行时回复内容。例如,提问器节点问题消息。

取值范围

不涉及。

表6 data

参数

参数类型

描述

text

String

参数解释

运行时输出内容消息块。

取值范围

不涉及。

index

Integer

参数解释

消息块索引。

取值范围

不涉及。

node_id

String

参数解释

节点ID。

取值范围

不涉及。

node_type

String

参数解释

工作流节点类型。

取值范围

不涉及。

node_name

String

参数解释

节点名称。

取值范围

不涉及。

workflow_id

String

参数解释

工作流ID。

取值范围

不涉及。

workflow_name

String

参数解释

工作流名称。

取值范围

不涉及。

createdTime

Integer

参数解释

创建时间。

取值范围

不涉及。

请求示例

调用运行时

{
  "method" : "POST",
  "url" : "https://api.example.com/agent/jiuwen-ef727077-9903-4e0a-9196-e93298bfcce3/invocations",
  "headers" : {
    "Authorization" : "Bearer sk-*******",
    "x-hw-agentarts-session-id" : 123456789
  },
  "body" : {
    "inputs" : {
      "query" : "你好"
    },
    "plugin_configs" : [ {
      "plugin_id" : "xxxxxxxxx",
      "config" : {
        "key" : "value"
      }
    } ]
  }
}

响应示例

状态码:200

成功响应。

{
  "event" : "message",
  "data" : {
    "text" : null,
    "index" : 11,
    "node_id" : "node_end",
    "node_type" : "End",
    "node_name" : "结束",
    "workflow_id" : "cd7a8f33-66e3-455c-b008-a6b18dd27319",
    "workflow_name" : "flowouttest",
    "createdTime" : 1760169416635
  },
  "createdTime" : 1760169416635
}

状态码

状态码

描述

200

成功响应。

错误码

请参见错误码

相关文档