调用智能体运行时的自定义接口 - ExecuteRuntimeWithPrefix
功能介绍
该接口用于使用前缀匹配方式调用已经部署好的高代码智能体运行时的自定义接口,使用该接口需要确保智能体运行时的URL的匹配模式设置为PREFIX_MATCH前缀匹配,部署智能体运行时请参见部署智能体运行时。
调用已经部署好的高代码智能体运行时中的自定义接口。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
POST /runtimes/{runtime_name}/invocations/{custom_path}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| runtime_name | 是 | String | 参数解释: 智能体运行时名称。 智能体运行时名称获取方式: 约束限制: 不涉及。 取值范围: 以小写字母开头,以小写字母或数字结尾,可以包含小写字母、数字和中划线,长度为2-48个字符。 默认取值: 不涉及。 |
| custom_path | 是 | String | 参数解释: 需要调用的智能体运行时的自定义接口URL路径,URL中最开头的一个斜杠需要删除。 约束限制: 不能以/开头,需确保智能体运行时URL匹配模式设置为PREFIX_MATCH前缀匹配。 取值范围: 包含英文字母,数字,特殊字符(- _ . ~ : / ? # [ ] @ ! $ & ' ( ) * + , ; = %),长度为1-256个字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Hw-Agentarts-Session-Id | 是 | String | 参数解释: 会话ID,每个会话的唯一标识符。用户可将会话ID设置为任意字符串,例如“123e4567e89b12d3a456426614174000”,无需在其他地方获取。 约束限制: 不涉及。 取值范围: 由英文,数字,“-”,“_”组成,不超过64位字符。 默认取值: 不涉及。 |
| X-Hw-Agentgateway-User-Id | 否 | String | 参数解释: 本次智能体运行时调用对应的用户唯一ID,用于标识此次调用的用户身份,用户可将会话ID设置为任意字符串,例如“123e4567e89b12d3a456426614174000”,无需在其他地方获取。 约束限制: 不涉及。 取值范围: 由英文,数字,“-”,“_”组成,不超过128位字符。 默认取值: 不涉及。 |
| Mcp-Session-Id | 否 | String | 参数解释: 本次MCP(Model Control Protocol)调用对应的会话唯一ID,用于标识同一次会话上下文,实现会话级别的状态保持、日志追踪与问题排查。用户可将会话ID设置为任意字符串,例如“123e4567e89b12d3a456426614174000”,无需在其他地方获取。 约束限制: 同一会话上下文内应保持一致。 取值范围: 由英文,数字,“-”,“_”组成,不超过128位字符。 默认取值: 不涉及。 |
| Mcp-Protocol-Version | 否 | String | 参数解释: 本次MCP协议通信版本,适配Streamable HTTP传输。客户端可指定版本,未传时服务端默认采用2025-03-26。 约束限制: 仅支持Streamable HTTP兼容版本:2025-03-26、2025-06-18、2025-11-25。 取值范围: 日期格式(YYYY-MM-DD),长度10字符。支持如下版本: 默认取值: 2025-03-26 |
| Authorization | 是 | String | 参数解释: 本次智能体运行时调用对应的身份认证凭据。需要根据实际的智能体运行时的入站身份认证方式获取对应的身份认证凭据。 API Key认证、IAM认证及OAuth 2.0认证具体请参见认证鉴权。 约束限制: 不涉及。 取值范围: 不超过4096位字符。 默认取值: 不涉及。 |
| X-Sdk-Content-Sha256 | 否 | String | 参数解释: 如果智能体运行时的入站认证类型为IAM认证时,需要指定该Header头为UNSIGNED-PAYLOAD。 约束限制: 不涉及。 取值范围: 固定为UNSIGNED-PAYLOAD。 默认取值: 不涉及。 |
响应参数
状态码:200
智能体调用成功的响应Body体。
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | Integer | 参数解释: 异常错误码。 取值范围: 不涉及。 |
| message | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | Integer | 参数解释: 异常错误码。 取值范围: 不涉及。 |
| message | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | Integer | 参数解释: 异常错误码。 取值范围: 不涉及。 |
| message | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
请求示例
-
调用用户自定义的/chat接口, gateway_domain为运行时的访问域名,可以在智能体运行时的运行时详情页面中获取
POST https://{gateway_domain}/runtimes/{runtime_name}/invocations/chat { "input" : "hello" } -
通过访问方式指定版本调用用户自定义的/chat接口, gateway_domain为运行时的访问域名,可以在智能体运行时的运行时详情页面中获取
POST https://{gateway_domain}/runtimes/{runtime_name}/invocations/chat?endpoint=dev { "input" : "hello" }
响应示例
状态码:200
智能体调用成功的响应Body体。
{
"output" : "hello"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 智能体调用成功的响应Body体。 |
| 401 | 未授权(认证令牌缺失、无效或已过期)。 |
| 404 | 运行时资源不存在。 |
| 500 | 服务器内部错误。 |
错误码
请参见错误码。