SDKs · Node.js

Node.js Control Plane

Use ControlPlaneClient for trusted account, organization, billing, session, project, export, integration, API-key, and webhook workflows. Protected methods use a bearer access token—not a memory API key.

Choose the correct credential

MemorySyncClient

Memory data plane.

Uses apiKey.
Uses project and end-user scope.
Does not accept a bearer access token.

ControlPlaneClient

Administrative control plane.

Uses accessToken for protected methods.
May use project scope where supported.
Does not send an end-user ID.

Create a protected client

control-plane.ts

import { ControlPlaneClient } from "memorysync-sdk";

const control = new ControlPlaneClient({
  baseUrl: "https://api.memorysync.io",
  accessToken: process.env.MEMORYSYNC_ACCESS_TOKEN!,
  projectId: process.env.MEMORYSYNC_PROJECT_ID,
});

const projects = await control.listProjects();
for (const project of projects) {
  console.log(project.id, project.name);
}

Curated control-plane methods

Area	Methods
API keys	`bulkRevokeApiKeys`, `testApiKey`
Authentication	`signup`, `login`, `refresh`, `logout`, `me`, `logoutAll`
Billing	`getCurrentPlan`
Sessions	`listSessions`, `revokeSession`
Integrations	`listIntegrations`
Organizations	`createOrganization`, `listOrganizations`
Projects	`listProjects`, `createProject`, `renameProject`, `archiveProject`, `unarchiveProject`, `deleteProject`
Exports	`createExport`, `listExports`, `getExport`, `cancelExport`, `retryExport`, `getExportDownloadUrl`
Webhooks	`createWebhook`, `listWebhooks`, `getWebhook`, `getWebhookEventTypes`, `getWebhookHealth`, `updateWebhook`, `deleteWebhook`, `pauseWebhook`, `resumeWebhook`, `rotateWebhookSecret`, `testWebhook`, `replayWebhookDeliveries`, `listWebhookDeliveries`, `getLatestWebhookDelivery`, `listRecentWebhookDeliveries`, `getWebhookDelivery`, `retryWebhookDelivery`

import { ControlPlaneClient } from "memorysync-sdk";

const loginClient = new ControlPlaneClient({
  baseUrl: "https://api.memorysync.io",
});

const result = await loginClient.login({
  email: "developer@example.com",
  password: process.env.MEMORYSYNC_PASSWORD!,
});

if (result.mfaRequired) {
  console.log("Complete the configured MFA flow");
} else {
  const accessToken = result.tokens.accessToken;
  // Store and use tokens only in an approved secure context.
}

Apply project scope explicitly

project-scope.ts

const control = new ControlPlaneClient({
  baseUrl: "https://api.memorysync.io",
  accessToken: process.env.MEMORYSYNC_ACCESS_TOKEN!,
  projectId: "project_default",
});

const defaultHooks = await control.listWebhooks();
const selectedHooks = await control.listWebhooks({
  projectId: "project_selected",
});

Every control-plane method accepts a final request-options object with an optional project override. Resolve the client default and override from authorized server state.

Create webhooks from trusted input

create-webhook.ts

const created = await control.createWebhook(
  {
    name: "Memory events",
    url: "https://hooks.example.com/memorysync",
    events: ["memory.created"],
    projectId: "project_selected",
  },
  { projectId: "project_selected" },
);

console.log(created.id);
// Treat created.secret as a secret and do not log it.

Create a scoped background export

create-export.ts

const exportJob = await control.createExport(
  { format: "jsonl", scope: "all" },
  { projectId: "project_selected" },
);

console.log(exportJob.job.id, exportJob.job.status);

Operation reference

Control-plane API pages

Open account, organization, project, export, billing, and webhook operations.

Node.js Types & Errors

Handle interfaces and typed failures.

API Authentication

Compare memory API keys and bearer authentication.

Production Patterns

Authorize, log, and reconcile administrative calls.

Was this page helpful?

← Previous

Types & Errors

cURL