SDK v5 Migration

SDK v5 makes RetainDB naming the public API.

Install v5

npm install @retaindb/sdk@5

Public names

Use these exports:

• RetainDB
• RetainDBClient
• RetainDBAgentRuntime
• RetainDBMemoryRouter
• createMemoryRouter

Environment variables

Use:

RETAINDB_API_KEY="rdb_..."
RETAINDB_PROJECT="production"

RETAINDB_KEY remains accepted by the simple SDK client for compatibility, but new docs standardize on RETAINDB_API_KEY.

Replace old imports

import { RetainDB, RetainDBClient } from "@retaindb/sdk";
import { createMemoryRouter } from "@retaindb/sdk/router";

New agent API

const db = new RetainDB({ apiKey: process.env.RETAINDB_API_KEY });
const task = db.agent("planner").task("checkout-redesign");

await task.event({
  type: "decision",
  summary: "Use hosted checkout for v1."
});

Recommended migration order

1. Upgrade package version.
2. Replace public imports with RetainDB names.
3. Move first-run docs and examples to RETAINDB_API_KEY.
4. Add db.agent().task() for multi-agent workflows.
5. Add Memory Router v1 only where you want provider-level chat injection.

Next: Agent task API.