Skip to main content

Quickstart

This page follows the current memorose-server API directly.

What you need

  • a running Memorose server on http://127.0.0.1:3000
  • dashboard credentials
  • jq
  • uuidgen
In the current single-node default setup, Memorose auto-initializes Raft at startup. You do not need to call /v1/cluster/initialize before sending writes unless you intentionally disabled raft.auto_initialize.

The happy path

  1. Log in and get a bearer token.
  2. Create a stream ID.
  3. Ingest one event.
  4. Retrieve against that stream.
  5. Check whether consolidation backlog is clear.

1. Set base variables

2. Log in and get a token

Current /v1 routes accept either a dashboard JWT bearer token or an API key. For local development, the dashboard login is the fastest path.

3. Create a stream ID

4. Ingest an event

Expected response shape:

5. Retrieve memory

Expected response shape:
Important response fields:
  • results[].unit.level: where the retrieved memory sits in the hierarchy
  • results[].unit.memory_type: factual or procedural
  • score: final ranking score after retrieval fusion
  • query_time_ms: observed server-side latency for the retrieval call

6. Check consolidation backlog

When "ready": true, the current pending-event backlog is clear.

Where to go next