帮你快速理解、总结文档立即下载

查询 Agent 详情

最近更新时间:2026-09-22 11:14:18
我的收藏

1. 接口描述

接口请求域名: workbuddyenterprise.tencentcloudapi.com 。

查询单个 Agent 的详细信息,包括基础配置和路由配置。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAgent。
Version String 公共参数,本接口取值:2026-07-09。
Region String 公共参数,本接口不需要传递此参数。
AgentId String

Agent 业务 ID


示例值:01M07AMA4*JT4BAPDK

3. 输出参数

参数名称 类型 描述
AgentId String Agent 业务 ID
示例值:01M07AMA4*JT4BAPDK
AgentName String Agent 名称
示例值:某某智能助手
Description String Agent 描述
示例值:某某智能助手,用来协助完成日常工作
AvatarUrl String 头像 URL
示例值:https://xxxx.com/xxxx.png
IsDebug Boolean 是否调试 Agent
示例值:false
CreatedTime String 创建时间(RFC3339)
示例值:2026-08-17T15:40:27.681+08:00
ModifiedTime String 更新时间(RFC3339)
示例值:2026-08-17T15:40:27.681+08:00
ActiveSessionCount Integer 当前活跃 session 数(ACTIVE/CREATING/MIGRATING,未软删);仅 DescribeAgent 读路径填充,写路径回显不下发
示例值:0
RoutingSet Array of RoutingItem 流量路由配置(VersionId 恒为字符串,防 JS 精度丢失)
A2AConfig A2AConfig A2A 对外互通配置与注册态(只读回显;原四个平铺字段收进结构)
AccountId String 绑定的 OneID 企业账号 ID。允许为空:未绑定的存量与新建 Agent 该字段缺省,绑定后回显绑定值
示例值:ent-9f8e7d6c
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询 Agent 详情

输入示例

POST / HTTP/1.1
Host: workbuddyenterprise.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAgent
<公共请求参数>

{
    "AgentId": "736918300000000001"
}

输出示例

{
    "Response": {
        "AgentId": "736918300000000001",
        "AgentName": "客服助手",
        "Description": "自动回复客户问题",
        "AvatarUrl": "https://cos.example.com/avatar.png",
        "IsDebug": false,
        "RoutingSet": [
            {
                "VersionId": "2087791755109965825",
                "Weight": 1.0
            }
        ],
        "CreatedTime": "2026-08-01T10:00:00Z",
        "ModifiedTime": "2026-08-10T15:30:00Z",
        "ActiveSessionCount": 3,
        "A2AConfig": {
            "A2AEnabled": true,
            "A2APublicRef": "a2a://workbuddy/736918300000000001",
            "A2AEndpoint": "https://a2a.example.com/card/736918300000000001",
            "A2AStatus": "REGISTERED"
        },
        "AccountId": "1438693592234206274",
        "RequestId": "3c6d138e-1234-5678-9abc-def012345678"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure.IdentityNotFound AuthFailure.IdentityNotFound
AuthFailure.IdentityResolutionFailed AuthFailure.IdentityResolutionFailed
FailedOperation.EntitlementNotFound FailedOperation.EntitlementNotFound
InternalError.AgentOperationFailed InternalError.AgentOperationFailed
InternalError.EntitlementCheckFailed InternalError.EntitlementCheckFailed
InternalError.MarshalFailed InternalError.MarshalFailed
InternalError.NoResolver InternalError.NoResolver
InternalError.Panic InternalError.Panic
InternalError.ReadBodyFailed InternalError.ReadBodyFailed
InternalError.ResolveEnterpriseFailed InternalError.ResolveEnterpriseFailed
InternalError.TenantResolveFailed InternalError.TenantResolveFailed
InternalError.Unknown InternalError.Unknown
InvalidParameter.ActionNotFound InvalidParameter.ActionNotFound
InvalidParameter.ActionRequired InvalidParameter.ActionRequired
InvalidParameter.AgentIDRequired InvalidParameter.AgentIDRequired
InvalidParameter.EmptyBody InvalidParameter.EmptyBody
InvalidParameter.InvalidJSON InvalidParameter.InvalidJSON
InvalidParameter.InvalidRequestBody InvalidParameter.InvalidRequestBody
MissingParameter.UinRequired MissingParameter.UinRequired
ResourceNotFound.Agent ResourceNotFound.Agent
UnauthorizedOperation.UnprovisionedTenant UnauthorizedOperation.UnprovisionedTenant