Skip to content
› QUICKSTART [0/4]

From zero to remember → recall in five minutes.

Two calls is the whole surface. Install the SDK, remember a fact, recall it ranked and token-budgeted — then trace every fact back to where it came from.

$ npm install @ultramemory/sdk-ts
Step 1 · install[1 / 4]

Add the SDK.

TypeScript and Python are first-class. Set UM_TOKEN from a scoped key in your dashboard.

npm install @ultramemory/sdk-ts
Step 2 · remember[2 / 4]

Write a fact — capture-first.

remember() returns right away with a trace_id; extraction happens behind it, so a write never blocks your agent.

import { UltraMemory } from "@ultramemory/sdk-ts";

const um = new UltraMemory({ token: process.env.UM_TOKEN! });

// remember is capture-first — it returns immediately with a trace_id.
const { trace_id } = await um.remember("Acme ships on Fridays.");
Step 3 · recall[3 / 4]

Read it back — ranked and current.

recall() returns the facts that matter now, token-budgeted — not raw chat history. A miss is surfaced, never hidden.

// recall returns ranked, token-budgeted, current-truth facts — not raw history.
const { results, miss_signal } = await um.recall("when does Acme ship?");

if (miss_signal) {
  // a miss is surfaced, never hidden — re-extract or widen scope.
} else {
  for (const fact of results) console.log(fact.text, fact.score);
}
Step 4 · go further[4 / 4]

Pick your altitude.

Wrap your model client, add the MCP plugin, or call the SDK/REST directly — subagents inherit memory automatically.

Two calls

Start with two calls.

remember → recall, then trace every fact back to its source.