REST API 参考
基础地址:
http://127.0.0.1:3000
认证
当前 /v1 路由支持:
Authorization: Bearer <dashboard-jwt>x-api-key: <api-key>
本地开发最快的路径是:
POST /v1/dashboard/auth/login
备注
所有 /api/v1/*、/v1/memories、/v1/search、/health 这类旧示例,都属于旧产品模型,不应再用于当前集成。
路由分组
公开登录
| 方法 | 路径 | 作用 |
|---|---|---|
POST | /v1/dashboard/auth/login | 获取 dashboard JWT |
记忆运行时
| 方法 | 路径 | 作用 |
|---|---|---|
POST | /v1/users/:user_id/streams/:stream_id/events | 摄入事件 |
POST | /v1/users/:user_id/streams/:stream_id/retrieve | 混合检索 |
POST | /v1/users/:user_id/graph/edges | 添加图谱边 |
GET | /v1/status/pending | 查看待处理事件积压 |
任务与目标
| 方法 | 路径 | 作用 |
|---|---|---|
GET | /v1/users/:user_id/streams/:stream_id/tasks/tree | 查询单个 stream 的任务树 |
GET | /v1/users/:user_id/tasks/tree | 查询用户全部任务树 |
GET | /v1/users/:user_id/tasks/ready | 查询 ready 任务 |
PUT | /v1/users/:user_id/tasks/:task_id/status | 更新任务状态 |
组织知识
| 方法 | 路径 | 作用 |
|---|---|---|
GET | /v1/organizations/:org_id/knowledge | 查询组织知识列表 |
GET | /v1/organizations/:org_id/knowledge/:id | 查询单条组织知识 |
GET | /v1/organizations/:org_id/knowledge/metrics | 查询组织知识指标 |
集群运维
| 方法 | 路径 | 作用 |
|---|---|---|
POST | /v1/cluster/initialize | 初始化集群 |
POST | /v1/cluster/join | 节点加入集群 |
DELETE | /v1/cluster/nodes/:node_id | 从集群移除节点 |
Dashboard API
Dashboard 路由挂在 /v1/dashboard 下,服务于运维 UI。
重要路由包括:
/v1/dashboard/stats/v1/dashboard/memories/v1/dashboard/graph/v1/dashboard/search/v1/dashboard/agents/v1/dashboard/cluster/status/v1/dashboard/organizations
集成说明
- 当前模型里
stream_id是路径中的 UUID。 - 文档以
README.md、config.example.toml、.env.example和crates/memorose-server/src/main.rs为准。 - 如果你在写自己的 client,建议先跑通 快速开始,再分头进入具体 endpoint 页。