跳转到主要内容

​
REST API 参考

API 基础地址： 
http://127.0.0.1:3000

​
认证（Authentication）

当前 /v1 路由支持以下两种认证方式：
  • Authorization: Bearer <dashboard-jwt>
  • x-api-key: <api-key>
本地开发时，最快的方式是： 
POST /v1/dashboard/auth/login
旧版文档中使用 /api/v1/*、/v1/memories、/v1/search 或 /health 的示例来自早期产品模型，不应用于当前集成。

​
路由分组

​
公开登录

MethodEndpoint用途
POST/v1/dashboard/auth/login获取仪表盘 JWT 令牌

​
记忆运行时（Memory Runtime）

MethodEndpoint用途
POST/v1/users/:user_id/streams/:stream_id/events写入事件
POST/v1/users/:user_id/streams/:stream_id/retrieve混合检索（Hybrid Retrieval）
POST/v1/users/:user_id/graph/edges添加图边
GET/v1/status/pending待处理事件积压

​
记忆维护（Memory Maintenance）

MethodEndpoint用途
DELETE/v1/users/:user_id/memories/:id硬删除一个记忆单元
POST/v1/users/:user_id/memories/semantic/preview预览语义更新或遗忘计划
POST/v1/users/:user_id/memories/semantic/execute执行已审核的语义计划

​
任务与目标（Tasks And Goals）

MethodEndpoint用途
GET/v1/users/:user_id/streams/:stream_id/tasks/tree单个流的任务树
GET/v1/users/:user_id/tasks/tree单个用户的所有任务树
GET/v1/users/:user_id/tasks/ready就绪任务
PUT/v1/users/:user_id/tasks/:task_id/status更新任务状态

​
组织知识（Organization Knowledge）

MethodEndpoint用途
GET/v1/organizations/:org_id/knowledge列出组织知识
GET/v1/organizations/:org_id/knowledge/:id获取单条知识记录
GET/v1/organizations/:org_id/knowledge/metrics组织知识指标

​
集群操作（Cluster Operations）

MethodEndpoint用途
POST/v1/cluster/initialize手动初始化集群
POST/v1/cluster/join将节点加入集群
DELETE/v1/cluster/nodes/:node_id从集群中移除节点

​
集成说明

  • stream_id 在当前模型中是 UUID 路径参数。
  • 对于单节点默认部署，Raft 自动引导默认启用。
  • 文档以 README.md、config.example.toml、.env.example 和 crates/memorose-server/src/main.rs 作为权威来源。
  • 如果你正在构建自己的客户端，请从快速开始入手，然后查阅各端点的详细页面。