Skip to main content

API 概览

MemoryLake API 让你将文档和对话导入项目,自动提取结构化事实,并使用自然语言搜索所有记忆来源。用它来构建具有长期记忆的 AI 应用。

基础 URL

认证

所有 API 请求都需要在 Authorization 头中提供 Bearer 令牌。详情请参阅认证。

API 章节

Core Memory Operations

3 个核心 API:导入文档、追加会话消息、搜索记忆。

文件库

文件存储 — 上传和管理文件,然后导入到项目中。

工作空间

创建和管理工作空间 — 用于数据隔离的顶层命名空间。

Actors

管理参与者身份及其关联的事实。

Agents

定义 AI Agent,支持版本管理和 A2A 协议。

技能

上传打包好的能力,通过安全审核后挂到 Agent 上。

Boundary

给一个记忆范围(项目、一个人和一个 Agent)命名,用一个 ID 引用它。

项目

管理项目及其文档、会话和事实。

团队

读取、重命名、创建和删除团队,转让所有权。

成员

成员名单、角色、虚拟成员与访问范围。

邀请

通过邮件邀请成员,撤销待处理的邀请。

API Key

创建、轮换和吊销 API Key。

访问控制

角色、权限规则、用户组,以及谁能访问每个资源。

用量与审计日志

额度、按模型和成员的消耗、用量明细与审计记录。

计费

订阅、额度余额与预警、订单和发票。

IM 集成

把 Agent 接入 Slack、飞书、钉钉和企业微信机器人。

通用模式

响应格式

所有响应遵循以下结构:
错误响应:

您自己的标识符

您创建的每个资源都有两个标识符。id 由平台铸造——前缀加 32 位十六进制,形如 actor-7b5470549febfaca2acc5a3ebcaa2138。custom_id 则是您带来的:这个东西在您自己系统里已有的标识符。 设置它,意味着您不必在自己的记录旁边再存一份我们的 id。用您应用里已有的用户 ID 创建 Actor,此后就能直接用它寻址:
custom_id 在您的租户内必须唯一,按资源种类计——两个 Actor 不能共用一个,但一个 Actor 和一个项目可以。删除资源后,它的 custom_id 可以重新使用。

分页

列表接口使用 continuation-token 分页: 查询参数:
  • page_size:每页条数
  • continuation_token:上一次响应返回的令牌,用于获取下一页
当响应中没有 continuation_token 时,表示没有更多页。

幂等请求

会改动团队的写接口(创建 Key、轮换 Key、邀请成员、修改角色等)支持可选的 Idempotency-Key 请求头,取值为任意唯一字符串,例如 UUID。24 小时内用同一个值重试,会重放第一次的响应(包括错误),而不会再执行一次改动;重放的响应带有 Idempotency-Replayed: true。同一个值配不同的参数,或在第一次请求尚未完成时重复使用,会被拒绝。新 API Key 这类密钥只在第一次的响应里返回。支持该请求头的接口会在请求头一节列出它。

时间戳

所有时间戳使用 ISO 8601 格式:
标注为「Unix 秒级时间戳」的字段(例如团队、成员、用量和计费接口中的时间)是整数,表示自 1970-01-01 UTC 起的秒数。

后续步骤

Core Memory Operations

从核心 API 开始 — 了解工作流程和前置依赖

认证

配置 API 凭证