本文档介绍如何构造 HTTP 请求来调用云数据库 Agent Memory 的 V3 API。
请求结构
服务地址
V3 API 的服务地址为:
https://memory.tdai.tencentyun.com
所有 V3 接口均以此为基地址,拼接路径即得完整 URL。例如:
POST https://memory.tdai.tencentyun.com/v3/conversation/addPOST https://memory.tdai.tencentyun.com/v3/atomic/search
通信协议
V3 API 仅支持 HTTPS 协议,不支持 HTTP 明文传输。
请求方法
所有 V3 API 均使用 POST 方法。请求体(Request Body)统一使用 JSON 格式。
请求头
每次请求需携带以下 HTTP 头:
请求头 | 是否必填 | 说明 |
Content-Type | 是 | 固定为 application/json |
Authorization | 是 | 格式为 Bearer <API Key>,API Key 在控制台「API 接入信息」页面获取 |
x-tdai-service-id | 是 | Memory 实例 ID,格式为 mem-xxxxxxxx,在控制台实例详情页获取 |
鉴权方式
V3 API 采用 API Key 鉴权。鉴权失败时服务端返回
401 Unauthorized 或业务 code 非 0 的错误响应。鉴权请求示例
curl -i -k -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer *********************************' \\-H "x-tdai-service-id: tdai-mem-xxxxxxxx" \\https://memory.tdai.tencentyun.com/v3/conversation/add \\-d '{"session_id":"agent-main:sess-001","messages":[{"role":"user","content":"你好"}]}'
参数类型
V3 API 参数采用以下数据类型:
类型 | 说明 |
String | 字符串 |
Integer | 整数 |
Array | JSON 数组 |
Object | JSON 对象 |
字符编码
所有请求与响应均使用 UTF-8 字符编码。