API 简介

Agent 记忆服务提供 HTTP API，用于管理记忆库（Bank），写入、检索和反思记忆，并管理心智模型、知识库、文档、指令、异步操作和 Webhook。

本文介绍调用方式和各模块的常用接口。完整的请求参数、响应字段和示例见各模块文档。

快速开始

认证与常用请求头

调用需携带：

1Authorization: Bearer <token>
2Content-Type: application/json   # 有 JSON 请求体时

Authorization 必填。有 JSON 请求体时还需 Content-Type: application/json。

接入地址

1https://cloud.memory.bj.baidubce.com/api

接口表中的路径直接拼接在该地址后。例如：

1https://cloud.memory.bj.baidubce.com/api/v1/default/banks/{bank_id}/memories/recall

通用路径前缀为 /v1/default/banks/{bank_id}/...。

错误

异步操作

异步 Retain、刷新心智模型、创建知识库页面等接口会返回 operation_id，可通过获取异步操作状态查询进度和结果。

关于 operationId

每个接口有唯一 operationId，便于在工单、日志与客户端代码里引用。

模块与常用接口

以下按模块列出常用接口。

Banks

创建、查询、更新和删除 Bank，管理 Bank 配置，触发或恢复 Consolidation，并查看 Bank 统计。

完整参数和示例见 Banks 模块。

Bank Templates

获取 Bank 模板的 JSON Schema，导出和导入 Bank 模板，便于在不同环境间复用配置。

完整参数和示例见 Bank Templates 模块。

Memory

写入、检索和反思记忆（Retain → Recall → Reflect），以及记忆的列出、查看、更新和清空。

完整参数和示例见 Memory 模块。

Knowledge Base

以目录和页面组成的树组织心智模型，支持异步创建页面、混合搜索和 Markdown 导出。

完整参数和示例见 Knowledge Base 模块。

Mental Models

创建和管理可刷新的合成知识，支持刷新、预览刷新结果和查看历史版本。

完整参数和示例见 Mental Models 模块。

Documents

按 document 查看、更新、删除和重新处理已写入的内容，并查看 document 的分块（chunk）。

完整参数和示例见 Documents 模块。

Document Transfer

异步导出 document、下载导出文件，以及异步导入 document，用于数据迁移。

完整参数和示例见 Document Transfer 模块。

Files

上传 PDF、DOCX、图片、音频等文件，自动转换为 Markdown 并异步写入记忆。

完整参数和示例见 Files 模块。

Entities

查询从记忆中抽取的实体列表、实体详情和实体共现图。

完整参数和示例见 Entities 模块。

Directives

创建和管理 directive（指令），约束记忆处理和推理时的行为。

完整参数和示例见 Directives 模块。

Operations

查询、取消、重试和删除异步操作，例如异步 Retain、刷新心智模型、创建知识库页面返回的 operation_id。

完整参数和示例见 Operations 模块。

Webhooks

注册、更新和删除 webhook 事件订阅，并查看投递记录。

完整参数和示例见 Webhooks 模块。