1. 接口描述
接口请求域名: workbuddyenterprise.tencentcloudapi.com 。
查询当前企业的 Agent 列表,支持分页、过滤和排序。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeAgentList。 |
| Version | 是 | String | 公共参数,本接口取值:2026-07-09。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| Offset | 否 | Integer | 偏移量,从 0 开始 示例值:0 |
| Limit | 否 | Integer | 返回数量,缺省为 20,最大 100 示例值:20 |
| Filters.N | 否 | Array of Filter | 过滤条件数组,多个 Filter 之间为 AND 关系,同一 Filter 内多个 Values 为 OR 关系 |
| SortBy | 否 | String | 排序字段 示例值:CreatedTime |
| SortDirection | 否 | String | 排序方向:ASC / DESC 示例值:DESC |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的 Agent 总数 示例值:1 |
| AgentSet | Array of AgentItem | Agent 列表(分页后);元素含 A2A / 公网 API 访问开关与地址、创建人 UIN、绑定的企业账号 ID |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询 Agent 列表
按名称模糊过滤并按创建时间倒序查询 Agent 列表
输入示例
POST / HTTP/1.1
Host: workbuddyenterprise.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAgentList
<公共请求参数>
{
"Offset": 0,
"Limit": 20,
"Filters": [
{
"Name": "AgentName",
"Values": [
"数据分析"
],
"ExactMatch": false
}
],
"SortBy": "created_at",
"SortDirection": "DESC"
}
输出示例
{
"Response": {
"TotalCount": 1,
"AgentSet": [
{
"AgentId": "736918300000000001",
"AgentName": "数据分析助手",
"Description": "负责每日运营数据的汇总与分析",
"AvatarUrl": "https://example.com/avatar/agent-001.png",
"CreatedTime": "2026-06-01T09:00:00Z",
"ModifiedTime": "2026-09-10T15:20:00Z",
"A2AEnabled": true,
"A2AEndpoint": "https://a2a.example.workbuddy.com/agents/736918300000000001/.well-known/agent-card.json",
"A2AStatus": "REGISTERED",
"PublicApiEnabled": true,
"PublicApiUrl": "https://736918300000000001-tc-nanjing.example-workbuddy.com",
"CreatorUin": "100012345678",
"AccountId": "1438693592234206274",
"SessionCount": 42,
"Model": "hunyuan-turbos-latest",
"LatestVersionId": "2087791755109965825",
"LatestVersionName": "prod-3"
}
],
"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。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
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.EmptyBody | InvalidParameter.EmptyBody |
| InvalidParameter.InvalidJSON | InvalidParameter.InvalidJSON |
| InvalidParameter.InvalidRequestBody | InvalidParameter.InvalidRequestBody |
| InvalidParameter.Pagination | InvalidParameter.Pagination |
| MissingParameter.UinRequired | MissingParameter.UinRequired |
| UnauthorizedOperation.UnprovisionedTenant | UnauthorizedOperation.UnprovisionedTenant |