Skip to main content

REST API Reference

Base API URL:

http://127.0.0.1:3000

Authentication

Current /v1 routes accept either:

  • Authorization: Bearer <dashboard-jwt>
  • x-api-key: <api-key>

For local development, the fastest path is:

POST /v1/dashboard/auth/login
note

Older docs examples that use /api/v1/*, /v1/memories, /v1/search, or /health are from an older product model and should not be used for current integrations.

Route Groups

Public Login

MethodEndpointPurpose
POST/v1/dashboard/auth/loginGet dashboard JWT token

Memory Runtime

MethodEndpointPurpose
POST/v1/users/:user_id/streams/:stream_id/eventsIngest an event
POST/v1/users/:user_id/streams/:stream_id/retrieveHybrid retrieval
POST/v1/users/:user_id/graph/edgesAdd graph edge
GET/v1/status/pendingPending event backlog

Tasks And Goals

MethodEndpointPurpose
GET/v1/users/:user_id/streams/:stream_id/tasks/treeTask tree for one stream
GET/v1/users/:user_id/tasks/treeAll task trees for one user
GET/v1/users/:user_id/tasks/readyReady-to-run tasks
PUT/v1/users/:user_id/tasks/:task_id/statusUpdate task status

Organization Knowledge

MethodEndpointPurpose
GET/v1/organizations/:org_id/knowledgeList organization knowledge
GET/v1/organizations/:org_id/knowledge/:idFetch one knowledge record
GET/v1/organizations/:org_id/knowledge/metricsOrganization knowledge metrics

Cluster Operations

MethodEndpointPurpose
POST/v1/cluster/initializeInitialize cluster
POST/v1/cluster/joinJoin node to cluster
DELETE/v1/cluster/nodes/:node_idRemove node from cluster

Dashboard API

Dashboard routes are nested under /v1/dashboard and back the operational UI.

Important routes include:

  • /v1/dashboard/stats
  • /v1/dashboard/memories
  • /v1/dashboard/graph
  • /v1/dashboard/search
  • /v1/dashboard/agents
  • /v1/dashboard/cluster/status
  • /v1/dashboard/organizations

Integration Notes

  • stream_id is a UUID path parameter in the current model.
  • The docs treat README.md, config.example.toml, .env.example, and crates/memorose-server/src/main.rs as the source of truth.
  • If you are building your own client, start from Quickstart and then fan out into the dedicated endpoint pages.