1. 接口描述
接口请求域名: cloudmate.tencentcloudapi.com 。
发起智能诊断对话
注意:使用该API时,请务必设置请求域名(Endpoint)为 cloudmate.ai.tencentcloudapi.com
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CloudMateAgent。 |
| Version | 是 | String | 公共参数,本接口取值:2025-10-30。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| WorkspaceId | 是 | String | 空间 ID 示例值:fa5234dc-0663-4447-ab71-ed2776fc1137 |
| Message | 是 | String | 用户提问内容 示例值:帮我分析下最近30分钟的系统错误 |
| ScenarioId | 否 | String | 场景 ID 示例值:01248bc1-c11f-4683-a960-11c534572424 |
| SessionId | 否 | String | 会话 ID - 填写上一次接口调用返回的会话 ID(SessionId),可在原有会话基础上继续对话 - 未填写会话 ID 时,创建新会话 示例值:ff9012c0-90d8-4bc2-9545-31fb5962bfb7 |
| Streaming | 否 | Boolean | 是否使用流式响应,默认为 false,不启用流式响应 示例值:false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SessionId | String | 会话ID,用于后续继续对话 示例值:534a6323-f958-4250-a45c-bd3b3dac5303 |
| Timestamp | Integer | Unix 时间戳 示例值:1763034032 |
| Content | ChatContent | 诊断内容 |
| Partial | Boolean | 是否为部分内容(流式场景) 示例值:true |
| TurnComplete | Boolean | 本轮对话是否完成 示例值:true |
| ErrorCode | String | 错误代码,无错误时无该字段 示例值:NOT_FOUND |
| ErrorMessage | String | 错误详细信息,无错误时无该字段 示例值:资源未找到 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。 |
4. 示例
示例1 发起智能诊断对话
输入示例
POST / HTTP/1.1
Host: cloudmate.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CloudMateAgent
<公共请求参数>
{
"WorkspaceId": "bd225f0e-8a75-4bd7-8bc3-99b026b41256",
"Message": "你是谁",
"ScenarioId": "d824d96c-7c07-4f6a-aef6-2f14a9fafb1e"
}
输出示例
{
"SessionId": "46be4923-6f58-4ccb-8a26-6f56aad4a17b",
"Timestamp": 1766561543,
"Content": {
"Role": "model_output",
"Parts": [
{
"Text": "我是 CloudMate,一个专注于帮助您解决云平台问题的 AI 助手。您可以随时向我描述您遇到的问题。"
}
]
},
"Partial": false,
"TurnComplete": true
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.OutOfRange | 参数内容超出限制 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.WorkspaceNotExist | 空间不存在 |