Documentation · start building

Everything you need to ship on Scopes.

Guides, references, and the agent-native API — start with the quickstart below, go deep on concepts, and ship in minutes.

API reference Read the concepts

Quickstart

Install the SDK

Add the Scopes SDK from npm. Works in Node, Bun, Deno, and the edge.

Authenticate

Initialize with your API key — or pass an Agent Capability Token for agent contexts.

Create an arc

Every relationship starts as an arc. Give it a name and an initial phase.

Append your first beat

Record any event — email, call, note, signal. It's signed, attributed, and permanent.

terminal

$npm install @scopes/sdk

added @scopes/sdk@0.1.0

const scopes = new Scopes({ apiKey: process.env.SCOPES_KEY });

const arc = await scopes.arcs.create({ name: "Acme Corp", phase: "active" });

await scopes.beats.append(arc.id, { kind: "note", body: "Intro call went well." });

→beat appended · id: beat_2xK9...

All documentation

Dive into any topic — or follow the quickstart above in order.

Quickstart

From zero to your first arc and beat in under five minutes.

this page

Concepts

Arcs, beats, phases, health, context documents — the model explained.

CLI reference

Every command, flag, and output format for the Scopes CLI.

REST API

Full endpoint reference with request/response schemas and auth details.

SDKs

TypeScript, Python, and Go clients — same surface, same guarantees.

Webhooks

Subscribe to arc events and push delivery with retry and DLQ built in.

Agent guide

First-class agent identity, capability tokens, and subscriptions.

Context API

How arcs compile to versioned, cacheable context documents agents read.

llms.txt · machine-readable

Docs your agents can read.

Scopes ships a structured llms.txt alongside a stable, fully-typed REST surface — so your agents can self-serve the documentation they need without scraping HTML or hallucinating schemas. Every endpoint, every type, every error code: machine-legible from day one.