集成接入
更新时间:2026-05-27
本文介绍通过 REST API 快速接入记忆服务的方法,适合希望直接通过 HTTP 调用验证服务连通性和基本功能的场景。 更多接入方式(MCP、Skill)详见接入方式总览。
操作步骤
第一步:拿到接⼊信息
确认 API Base URL、API Key 和 记忆库 ID。
第二步:检查连通性
调⽤健康检查或版本接⼝,确认服务可访问。
第三步:写入一条测试记忆
调⽤存储接⼝写⼊⼀段不含敏感信息的测试⽂本。
第四步:检索测试记忆
调⽤检索接⼝,⽤⾃然语⾔搜索刚才写⼊的内容。
第五步:接入 Agent 流程
在⽤户输⼊前检索,在任务结束或回复后存储;需要总结判断时调⽤反思。
Bash
1# 1. 设置本机环境变量。API Base URL 已包含 /api,不要再额外拼接 /api。
2export MEMORY_API_BASE_URL="https://cloud.memory.bj.baidubce.com/api"
3export MEMORY_BANK_ID="your-bank-id"
4# 2. 注⼊ API Key。输⼊时不回显,避免出现在终端历史或截图中。
5read -rsp "MEMORY_API_KEY: " MEMORY_API_KEY
6export MEMORY_API_KEY
7# 3. 检查服务状态
8curl "$MEMORY_API_BASE_URL/health"
9# 4. 查看版本(需要认证)
10curl "$MEMORY_API_BASE_URL/version" \
11-H "Authorization: Bearer $MEMORY_API_KEY"
12# 5. 写入一条测试记忆
13curl "$MEMORY_API_BASE_URL/memories/retain" \
14 -H "Authorization: Bearer $MEMORY_API_KEY" \
15 -H "Content-Type: application/json" \
16 -d '{"bank_id": "'"$MEMORY_BANK_ID"'", "items": [{"content": "用户偏好使用 TypeScript 和 React 进行前端开发。", "tags": ["user:demo"], "document_id": "quickstart-test"}]}'
17# 6. 检索刚才写入的记忆
18curl "$MEMORY_API_BASE_URL/recall" \
19 -H "Authorization: Bearer $MEMORY_API_KEY" \
20 -H "Content-Type: application/json" \
21 -d '{"bank_id": "'"$MEMORY_BANK_ID"'", "query": "用户偏好的前端技术是什么?", "tags": ["user:demo"], "tags_match": "any_strict"}'
注意:API Key 应通过环境变量、密钥管理系统或运⾏平台的安全配置注⼊。不要把真实 API Key 写⼊源码、README、截图或⽤户⼿册中。
认证与请求规范
所有受保护接⼝都使⽤ HTTP Bearer 认证。请求头中传⼊ API Key,服务端会校验有效期、撤销状态和配额。
| 项⽬ | 说明 |
|---|---|
| API Base URL | 接⼝基础地址,由平台或管理员提供。示例中使⽤环境变量 MEMORY_API_BASE_URL,实际值如 https://cloud.memory.bj.baidubce.com/api |
| Authorization | 格式为 Bearer + API Key。示例中使⽤环境变量 MEMORY_API_KEY。 |
| Content-Type | JSON 请求使⽤ application/json;⽂件上传使⽤multipart/form-data,由客户端⾃动⽣成边界。 |
| Bank ID | 每个请求通过 bank_id 或路径中的 bankId 指定⽬标记忆库 |
| 响应格式 | 默认返回 JSON。错误响应通常包含 error、detail 或 message 字段。 |
Bash
1curl "$MEMORY_API_BASE_URL/banks" \
2 -H "Authorization: Bearer $MEMORY_API_KEY" \ # 环境变量引⽤,不是 API Key 的值
3 -H "Content-Type: application/json"
评价此篇文章
