一、接口介绍
鉴权接口用于验证 API 密钥的有效性。共1个接口:
| 接口 | 方法 | 功能 |
| /v3/auth/verify | POST | 验证鉴权信息 |
二、验证鉴权信息
验证当前请求携带的 API Key 和实例 ID 是否有效。
POST /v3/auth/verify
三、请求参数
无额外请求参数,鉴权信息通过 Header 传递。
四、请求示例
curl -i -X POST \\ -H 'Content-Type: application/json' \\ -H 'Authorization: Bearer *********************************' \\ -H "x-tdai-service-id: tdai-mem-xxxxxxxx" \\ https://memory.tdai.tencentyun.com/v3/auth/verify \\ -d '{}'
五、响应示例
{ "code":0, "message":"ok", "request_id":"req-7fd3b2dd", "data":{ "valid":true, "service_id":"tdai-mem-xxxxxxxx", "user_id":"user-123" }}
六、响应 data
| 字段 | 类型 | 说明 |
| valid | bool | 鉴权信息是否有效 |
| service_id | string | 当前实例 ID |
| user_id | string | 当前用户 ID(如有) |
七、错误码
| HTTP 状态码 | 错误信息 | 说明 |
| 400 | request: Invalid input | 请求参数不合法。 |
| 401 | Missing or invalid Authorization header | Bearer API Key 缺失或格式不正确。 |
| | Missing x-tdai-service-id header | 请求头中未携带 x-tdai-service-id。 |
| 401 | AUTH_FAILED | API Key 无效或已过期。 |
| 500 | Internal error | 服务内部错误,可有限重试。 |