Hosted quickstart

This guide takes you from a blank terminal to your first remember and recall calls against Spectron Cloud. No infrastructure to provision – Spectron Cloud runs the server, SurrealDB, and object store for you.

Create an account at api.spectron.dev. In the dashboard:

Click New Context and choose a name (for example acme-prod) and region.
Open the Context and create an API key. Copy it immediately – it is shown only once.

Step 2 — Set environment variables

export SPECTRON_URL="https://api.spectron.dev"
export SPECTRON_CONTEXT_ID="acme-prod"
export SPECTRON_API_KEY="sk-..."

Step 3 — Remember a fact

curl -sS "$SPECTRON_URL/api/v1/$SPECTRON_CONTEXT_ID/facts" \
  -H "API-KEY: $SPECTRON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "I was just promoted to CTO.",
    "infer": "full",
    "scope": ["org=acme", "user=alice"]
  }'

The response includes a structured extraction diff and a trace_id.

Step 4 — Recall

curl -sS "$SPECTRON_URL/api/v1/$SPECTRON_CONTEXT_ID/query" \
  -H "API-KEY: $SPECTRON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "What is Alice'\''s role?",
    "scope": ["org=acme", "user=alice"]
  }'

Check tier in the response – tier 1 or 2 hits avoid a full LLM synthesis pass.

Step 5 — Optional chat

curl -sS "$SPECTRON_URL/api/v1/$SPECTRON_CONTEXT_ID/chat" \
  -H "API-KEY: $SPECTRON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Summarise what you know about me",
    "scope": ["org=acme", "user=alice"]
  }'

SDKs

Generated clients are published as surrealdb-spectron (Python) and @surrealdb/spectron (TypeScript). See Integrations and the REST API for the full surface.

Next steps

Surrealist dashboard quickstart – UI-first tour
Sessions and turns
Contexts and scope
Uploading documents