TMCRA MEMORY API / v0.2.0
面向生产级 AI Agent 的持久记忆 API。
把有序对话事件转化为租户隔离、具备时间结构、可直接供模型使用的证据。TMCRA 负责记忆,你的应用继续掌控 Agent Runtime 和最终回答模型。
- 协议
- HTTPS / JSON
- 鉴权
- Bearer token
- 写入模型
- 异步任务
- 召回输出
- 证据,不代答
快速接入
完成一次写入,再以读己之写方式召回。
- 1
只在服务端保存凭据
Root Key 只用于可信基础设施;外部集成使用 Scoped Token。
- 2
选择稳定的 Scope
把租户用户、Persona 或 Workspace 映射到长期稳定且不透明的 scope_name。
- 3
幂等写入
使用稳定 Message ID 和 Idempotency-Key 提交有序消息。
- 4
在模型调用前召回
把 prompt_evidence.content 与近期对话上下文一起交给回答模型。
curl -X POST "$TMCRA_BASE_URL/v1/scopes/user_123/ingest" \
-H "Authorization: Bearer $TMCRA_TOKEN" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: ingest-session-42-v1" \
-d '{
"session_id": "session_42",
"consistency": "read_your_writes",
"slow_policy": "auto",
"messages": [{
"message_id": "msg_001",
"role": "user",
"content": "I prefer concise answers.",
"timestamp": "2026-07-16T08:00:00Z"
}]
}'身份与隔离
Tenant、Scope 与 Session 是三种不同边界。
tenant由 Root API Key 标识的计费、凭据和管理边界。
scope_name面向一个用户、Persona 或 Workspace 的持久记忆隔离边界。
session_idScope 内的一段有序对话,不从消息正文推断。
一致性
成功消息只提交一次,后续阶段可以独立恢复。
| 模式 | 适用场景 | 行为 |
|---|---|---|
eventual | 下一轮不依赖本次写入。 | 立即返回异步 Job。 |
read_your_writes | 下一次召回必须包含本次提交。 | 等待 Job 完成,再把 wait_for_job_id 传给召回。 |
消息成功提交后,不会因为慢图演化、索引、Webhook 投递或调用方回答阶段随后失败而被重复写入。
Webhooks
带签名、且不暴露记忆正文的生命周期通知。
Webhook 采用至少一次投递。请验证 HMAC-SHA256 签名、按 Event ID 去重并快速返回成功响应。Payload 只包含脱敏 Job 与 Scope 元数据,不包含 Prompt、消息、证据或凭据。
job.succeededjob.failedjob.cancelledingest.completedconsolidation.completedindex.completedexport.readyscope.deleted错误与重试
根据操作语义重试,而不是只看状态码。
| 状态码 | 调用方处理 |
|---|---|
400 / 422 | 修正参数校验或请求语义后再重试。 |
401 / 403 | 更换或调整凭据权限,不要原样重试。 |
404 | 资源不存在,或超出当前凭据边界。 |
409 | 检查生命周期、幂等或一致性冲突详情。 |
429 | 遵守 Retry-After,并复用相同幂等键。 |
5xx | 仅对 GET 和幂等写入进行有界退避重试。 |
SDK 与适配器
直接使用稳定 API 合同,并按发布状态评估各接入包。
PREVIEW · tmcra-client供试用评估的类型化同步与异步客户端。
PREVIEW · @tmcra/typescript可测试的 Fetch 客户端,软件包接口仍可能调整。
PREVIEW · stdio面向获批测试部署的本地兼容层。
PILOT SOURCE · TMCRALangGraphMemory已验证的源码适配器,不代表已有公开发行包。
PILOT SOURCE · TMCRAAgentsMemory已验证的源码适配器,仅通过获批试用提供。
PILOT SOURCE · LanguageModelV3Middleware已验证的源码中间件,仅通过获批试用提供。
PILOT SOURCE · TmcraAIContextProvider已验证的源码 Provider,仅通过获批试用提供。
API 参考
32 个已记录的 API 操作。
访问凭据
签发、查看和撤销最小权限访问令牌。
05GET/v1/session获取当前认证会话+
返回当前 Token 对应的租户、凭据身份、权限和允许访问的记忆 Scope。
查看 OpenAPI SchemaGET/v1/access-tokens列出访问令牌+
返回当前租户的令牌元数据;令牌密钥不会再次返回。
查看 OpenAPI SchemaPOST/v1/access-tokens签发访问令牌+
创建带有效期、明确权限和 Scope 白名单的访问令牌。
查看 OpenAPI SchemaPOST/v1/access-tokens/{token_id}/confirm确认临时 Token 已安全交付+
幂等确认临时 Token 已由客户端安全保存,并启用其完整有效期。
查看 OpenAPI SchemaDELETE/v1/access-tokens/{token_id}撤销访问令牌+
立即撤销当前租户拥有的指定令牌。
查看 OpenAPI Schema记忆读写
写入对话事件、召回证据,并触发慢图演化。
06POST/v1/scopes/{scope_name}/ingest写入记忆事件+
通过可靠异步写入链提交一个 Session 的有序消息。
查看 OpenAPI SchemaPOST/v1/scopes/{scope_name}/ingest/batch批量写入+
为最多 100 个独立写入项原子预留容量和幂等记录。
查看 OpenAPI SchemaPOST/v1/scopes/{scope_name}/recall召回记忆+
返回结构化证据和有界 prompt_evidence,交由调用方的回答模型使用。
查看 OpenAPI SchemaPOST/v1/scopes/{scope_name}/consolidate整理慢图记忆+
为指定 Scope 排队执行受策略门控的慢图演化。
查看 OpenAPI SchemaGET/v1/scopes列出记忆范围+
列出当前凭据有权访问的 Scope,并可按获准前缀筛选。
查看 OpenAPI SchemaGET/v1/scopes/{scope_name}/summary查看 Scope 摘要+
返回指定 Scope 在服务端记录的写入、召回、消息和 Session 活动。
查看 OpenAPI Schema异步任务
查看和控制异步任务,不重放已经成功的写入。
03GET/v1/jobs/{job_id}查询任务+
返回异步任务的当前状态、结果或结构化错误。
查看 OpenAPI SchemaPOST/v1/jobs/{job_id}/cancel取消任务+
请求取消尚未进入终态的任务。
查看 OpenAPI SchemaPOST/v1/jobs/{job_id}/retry重试失败任务+
为符合条件的失败任务创建一次新的有界重试。
查看 OpenAPI Schema记忆图谱
先查看慢图,再按需展开快图和 Source 原始证据。
04GET/v1/scopes/{scope_name}/memory-graph获取图谱概览+
返回分页的慢图优先概览和各层数量。
查看 OpenAPI SchemaGET/v1/scopes/{scope_name}/memory-graph/nodes/{memory_id}/neighbors展开相邻节点+
按需展开指定记忆周围的 Slow、Fast 和 Source 节点。
查看 OpenAPI SchemaGET/v1/scopes/{scope_name}/memory-graph/nodes/{memory_id}/evidence读取原始证据+
返回显式请求的 Source 原文证据及其来源信息。
查看 OpenAPI SchemaPOST/v1/scopes/{scope_name}/memory-graph/trace追踪召回链路+
运行生产召回规划器并返回路由诊断,不调用回答模型。
查看 OpenAPI Schema治理与生命周期
导出、保留、删除、重开并评价记忆 Scope。
07POST/v1/scopes/{scope_name}/exports创建 Scope 导出+
排队生成指定 Scope 的一致、可迁移记忆导出。
查看 OpenAPI SchemaGET/v1/scopes/{scope_name}/exports/{export_id}下载 Scope 导出+
在同一租户与 Scope 边界内下载已经完成的导出。
查看 OpenAPI SchemaGET/v1/scopes/{scope_name}/retention获取保留策略+
返回指定 Scope 当前生效的非活跃数据保留策略。
查看 OpenAPI SchemaPUT/v1/scopes/{scope_name}/retention设置保留策略+
启用、停用或修改 1 至 3650 天的非活跃保留策略。
查看 OpenAPI SchemaPOST/v1/scopes/{scope_name}/feedback提交召回反馈+
记录 helpful、incorrect、stale、unsafe 或 missing 类型的证据反馈。
查看 OpenAPI SchemaDELETE/v1/scopes/{scope_name}删除 Scope+
排队物理删除记忆产物,同时保留生命周期与审计墓碑。
查看 OpenAPI SchemaPOST/v1/scopes/{scope_name}/reopen重开已删除 Scope+
将符合条件的墓碑 Scope 恢复为 active,但不会恢复已经删除的记忆产物。
查看 OpenAPI SchemaWebhook
接收带签名的生命周期事件,不暴露记忆正文。
03GET/v1/webhooks列出 Webhook+
列出端点元数据和订阅事件,不返回签名密钥。
查看 OpenAPI SchemaPOST/v1/webhooks创建 Webhook+
注册 HTTPS 端点,并一次性返回 HMAC 签名密钥。
查看 OpenAPI SchemaDELETE/v1/webhooks/{endpoint_id}停用 Webhook+
停用当前租户拥有的指定投递端点。
查看 OpenAPI Schema用量
查看租户级用量与成本账本。
04PUT/v1/usage/entitlements/{subject}设置用户额度+
为指定用户设置服务端生效的写入 Token 与召回次数上限。
查看 OpenAPI SchemaGET/v1/usage/quota查看额度+
返回当前调用主体或获准用户的服务端用量、上限与剩余额度。
查看 OpenAPI SchemaPUT/v1/usage/quota更新额度上限+
更新明确指定用户的服务端额度上限。
查看 OpenAPI SchemaGET/v1/usage/costs获取用量成本+
返回租户成本账本,用于运营核算与限额管理。
查看 OpenAPI Schema