Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nusomi.com/llms.txt

Use this file to discover all available pages before exploring further.

Pick the install path that matches where the work happens — native desktop, browser, or SDK. Capture your first session in under five minutes.

​
1. Install

Download the macOS app and run the installer:
curl -sL https://nusomi.com/install/macos | sh
Notarized + auto-update. First launch will prompt for Screen Recording and Accessibility permissions in System Settings.

​
2. Get an API key

  1. Sign in at nusomi.com (private beta — request an account).
  2. Copy your API key from the dashboard.
  3. Set it in your environment:
export NUSOMI_API_KEY="nsk_live_..."

​
3. Start your first session

import { Nusomi } from "@nusomi/sdk";

const nusomi = new Nusomi({ apiKey: process.env.NUSOMI_API_KEY });

// Start recording a workflow run
const session = await nusomi.sessions.create({
  workflow: "process_invoice",
  metadata: { vendor: "Acme", amount: 4500 },
});

await session.start();

// ...do the work...

await session.stop();
console.log("Session captured:", session.id);

​
4. Query what was captured

// Pull every event from the run
const events = await nusomi.events.query(session.id);

// Filter to just the errors
const errors = await nusomi.events.query(session.id, {
  type: "error",
});

​
5. Replay it

const replay = await nusomi.replay.exact(session.id);
That’s the loop: record → query → replay. Everything else (recovery, training-data export, memory search) builds on these three primitives.

​
What’s next

Concepts

Sessions, frames, events, replay — the model.

SDK reference

Full TypeScript and Python surface.

Recipes

End-to-end examples for common workflows.

Self-hosted

Run Nusomi inside your VPC.