1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
创建 Agent
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateAIWorkbenchAgent。 |
| Version | 是 | String | 公共参数,本接口取值:2023-06-16。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| Name | 否 | String | Agent 名称 示例值:资源巡检助手 |
| Description | 否 | String | Agent 描述 示例值:用于协助进行资源地图的巡检 |
| Category | 否 | String | Agent 分类 示例值:monitor |
| Tags.N | 否 | Array of String | Agent 标签 示例值:["monitor"] |
| Instruction | 否 | InstructionConfig | Agent 提示词 |
| SkillIds.N | 否 | Array of String | 关联技能 ID 列表 示例值:["skill-cust-file-parser-002"] |
| Source | 否 | String | 来源: builtin / custom 示例值:custom |
| ResourceMapId | 否 | String | 关联的资源地图 ID 示例值:coll-**** |
| MCPIds.N | 否 | Array of String | 关联的mcp工具 示例值:["mcp-***"] |
| CamTags.N | 否 | Array of Tag | 资源标签 |
| EnvVars.N | 否 | Array of EnvVar | agent运行时环境变量 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AgentId | String | Agent ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:agt-**** |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 create
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIWorkbenchAgent
<公共请求参数>
{
"Name": "testname",
"Description": "desc",
"Category": "monitor",
"Tags": [
"monitor"
],
"Instruction": {
"RolePosition": "你身边的实战派 SRE 排障搭子",
"CoreDuty": "线上故障应急响应:快速定位异常根因",
"CoreTruths": "主动前置不被动:不等你追问,预判需求、提前行动",
"Vibe": "直白接地气:拒绝黑话堆砌",
"Boundaries": "不擅自执行生产环境高危操作"
},
"Source": "custom",
"ResourceMapId": "coll-********",
"MCPIds": [
"mcp-***"
],
"SkillIds": [
"skill-cust-file-parser-002"
]
}
输出示例
{
"Response": {
"AgentId": "agt-********",
"RequestId": "9132e8b0-f470-4f51-aab0-e180e549163c"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| UnauthorizedOperation | 未授权操作。 |