Docs

API reference

The Sypnia HTTP API: one API for the open-source engine and for Sypnia Cloud, with every endpoint, parameter, response and error.

Applies to EngineCloud At launch

View as Markdown
On this page
  1. Start here
  2. Read
  3. Send and manage

Engine Cloud Everything Sypnia knows about your app is in this API: problems with their cause, sessions and their replays, traces, performance, uptime, alerts. The app, the Console, the MCP server and the CLI are built on it, so anything they show, your own code can read.

It is the same API on a self-hosted engine and on Sypnia Cloud. An endpoint that exists in only one says so with a badge.

Terminal
curl "https://api.sypnia.com/v1/problems?status=open" \
  -H "Authorization: Bearer $SYPNIA_API_TOKEN"
Base URLhttps://api.sypnia.com/v1 on Sypnia Cloud, <your base URL>/v1 on your engine
CredentialsAn API token (sps_…) to read and manage; an ingest key (spk_…) to send; the root token on your own engine
FormatJSON in, JSON out. Timestamps in UTC
Contractspec/openapi.yaml in the docs repository, OpenAPI 3.1. These pages are generated from it

Start here

Read

  • Problems

    List problems, get one with its full context, the ready prompt, and mark it resolved.
  • Sessions and replays

    Sessions, their timeline, their replay, people and accounts.
  • Traces

    One request, from the browser to the calls behind the API.
  • Performance

    Page vitals, API calls, click maps, form failures, weekly suggestions.
  • Uptime

    Checks, their status and their results.
  • Alerts and webhooks

    Alerts, the rules behind them, and signed webhooks.

Send and manage

Sections

Start hereWhat Sypnia is, how it works, what is open source and what is the paid cloud, and the two ways to get your first problem in plain words.ConceptsThe ten ideas Sypnia is made of, each defined precisely, from a project and its keys to problems, traces and alerts.SDKsHow your app sends data to Sypnia. One SDK for the browser, one for Node, one for Next.js, and the OpenTelemetry intake for every other backend.The agentHow Sypnia analyses a problem, what it writes, what it sends to a model and what it never does.MCP and skillsConnect your coding agent to Sypnia so it can ask what is failing in production, read what it needs to fix it, and set Sypnia up for you.API referenceThe Sypnia HTTP API: one API for the open-source engine and for Sypnia Cloud, with every endpoint, parameter, response and error.CLI referenceThe sypnia command: how to install it, the variables it reads, what its exit codes mean, and where each command is documented.Self-hostingWhat you run when you host the Sypnia engine yourself, what you need, what it costs, and what you do not get compared with Sypnia Cloud.How the engine is builtThe whole Sypnia engine on one page, from a click in your app to the sentence your coding agent reads, with the design rules and the code that holds them.Sypnia CloudHow the paid service works, from organizations and roles to plans, limits, billing, where your data lives, the GitHub App and support.Privacy and securityWhat Sypnia collects from your app and its users, what it never collects, how masking works, how to delete data, and how the service is protected.LicensingWhich licence covers each part of Sypnia, what you may do with it, how the name may be used, and the terms of a contribution.GuidesStep-by-step recipes for the common ways to use Sypnia, from apps made with AI builders and Next.js on Vercel to Supabase, source maps in CI, alert e-mails from your own engine, and moving from Sentry.ReferenceThe pages you look things up in, from the event schema and the glossary to what is planned, the changelog and the common questions.
↑↓ to move↵ to openEsc to close