commit 03e69e6781b670d0f16c9150277b0e0cc3635740 Author: 8ga Date: Thu Jul 23 12:56:44 2026 +0800 添加 example_rest_api_doc.md diff --git a/example_rest_api_doc.md b/example_rest_api_doc.md new file mode 100644 index 0000000..956e74a --- /dev/null +++ b/example_rest_api_doc.md @@ -0,0 +1,60 @@ +# 智能体使用数据 + +以下是关于智能体使用数据的API文档。 + +## 累计使用数据卡片 + +- 请求地址:/agent/metrics/total +- 请求方式:GET + +### 请求参数 + +| 参数名称 | 是否必传 | 类型 | 描述 | +|:-----|:-----|:-----|:-----| +| agentId | 是 | String | 智能体ID | + +### 请求示例 + +```bash +curl -X GET {gateway}/agent/metrics/total?agentId={agentId} +``` + +### 响应参数 + +| 参数名称 | 类型 | 描述 | +|:-----|:-----|:-----| +| code | Number | 返回码(200=成功) | +| msg | String | 提示信息 | +| data | Object | 返回数据 | +| data.agentId | String | 智能体 ID | +| data.agentName | String | 智能体名称 | +| data.inputToken | Number | 累计输入Token | +| data.outputToken | Number | 累计输出Token | +| data.userNum | Number | 累计用户数 | +| data.chatNum | Number | 累计对话数 | + +### 成功示例 + +```json +{ + "code": 200, + "msg": "操作成功", + "data": { + "agentId": "123456", + "agentName": "智能体名称", + "inputToken": "123243654645", + "outputToken": "345645765765", + "userNum": 5678, + "chatNum": 45678999 + } +} +``` + +### 失败示例 + +```json +{ + "code": 500, + "msg": "错误信息" +} +``` \ No newline at end of file