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

调用智能体运行时 - InvokeRuntime

功能介绍

该接口用于调用已经部署好的高代码智能体运行时,部署智能体运行时请参见部署智能体运行时

适用场景:

调用已经部署好的高代码智能体运行时。

URI

POST /agent/{agent_name}/invocations

表1 路径参数

参数

是否必选

参数类型

描述

agent_name

String

参数解释

智能体运行时名称。

智能体运行时名称获取方式:

  1. 进入AgentArts平台,在左侧导航栏选择“部署运行 > 智能体运行时 ”。

  2. 在智能体运行时列表中“智能体运行时名称/ID”处获取智能体运行时名称。

约束限制:

不涉及。

取值范围

以小写字母开头,以小写字母或数字结尾,可以包含小写字母、数字和中划线,长度为2-48个字符。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

endpoint

String

参数解释

用于调用智能体运行时使用的访问方式名称,访问指定的智能体运行时版本。

获取访问方式名称请参考如下:

  1. 进入AgentArts平台,在左侧导航栏选择“部署运行 > 智能体运行时 ”。

  2. 单击已创建的智能体运行时名称,在“基本信息”页签下即可查看访问方式。

如未创建访问方式,则默认使用该运行时的Latest访问方式。

约束限制:

不涉及。

取值范围

以字母开头,以字母或数字结尾,可以包含字母、数字和中划线,长度为2-48个字符。

默认取值:

Latest

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Hw-Agentarts-Session-Id

String

参数解释

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

约束限制:

不涉及。

取值范围

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

默认取值:

不涉及。

X-Hw-Agentgateway-User-Id

String

参数解释

本次智能体运行时调用对应的用户唯一ID,用于标识此次调用的用户身份,用户可将会话ID设置为任意字符串,例如“123e4567e89b12d3a456426614174000”,无需在其他地方获取。

约束限制:

不涉及。

取值范围

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

默认取值:

不涉及。

Authorization

String

参数解释

本次智能体运行时调用对应的身份认证凭据。需要根据实际的智能体运行时的入站身份认证方式获取对应的身份认证凭据。

API Key认证、IAM认证及OAuth 2.0认证具体请参见认证鉴权

约束限制:

不涉及。

取值范围

不超过4096位字符。

默认取值:

不涉及。

X-Sdk-Content-Sha256

String

参数解释

如果智能体运行时的入站认证类型为IAM认证时,需要指定该Header头为UNSIGNED-PAYLOAD。

约束限制:

不涉及。

取值范围

固定为UNSIGNED-PAYLOAD。

默认取值:

不涉及。

响应参数

状态码:200

智能体调用成功的响应Body体。

状态码:401

表4 响应Body参数

参数

参数类型

描述

code

Integer

参数解释:

异常错误码。

取值范围:

不涉及。

message

String

参数解释

错误详细信息。

取值范围

长度为 1 - 512 个字符。

状态码:500

表5 响应Body参数

参数

参数类型

描述

code

Integer

参数解释:

异常错误码。

取值范围:

不涉及。

message

String

参数解释

错误详细信息。

取值范围

长度为 1 - 512 个字符。

请求示例

POST https://{Endpoint}/agent/{agent_name}/invocations

{
  "input" : "hello"
}

响应示例

状态码:200

智能体调用成功的响应Body体。

{
  "output" : "hello"
}

状态码

状态码

描述

200

智能体调用成功的响应Body体。

401

未授权(认证令牌缺失、无效或已过期)。

500

服务器内部错误。

错误码

请参见错误码

相关文档