API reference
The Sypnia HTTP API: one API for the open-source engine and for Sypnia Cloud, with every endpoint, parameter, response and error.
On this page
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.
curl "https://api.sypnia.com/v1/problems?status=open" \
-H "Authorization: Bearer $SYPNIA_API_TOKEN"| Base URL | https://api.sypnia.com/v1 on Sypnia Cloud, <your base URL>/v1 on your engine |
| Credentials | An API token (sps_…) to read and manage; an ingest key (spk_…) to send; the root token on your own engine |
| Format | JSON in, JSON out. Timestamps in UTC |
| Contract | spec/openapi.yaml in the docs repository, OpenAPI 3.1. These pages are generated from it |
Start here
- The base URL, the three credentials and their scopes, and the endpoints that span a project.
- The one error shape, rate limits, cursors, time ranges, idempotency, versioning.
Read
- List problems, get one with its full context, the ready prompt, and mark it resolved.
- Sessions, their timeline, their replay, people and accounts.
- One request, from the browser to the calls behind the API.
- Page vitals, API calls, click maps, form failures, weekly suggestions.
- Checks, their status and their results.
- Alerts, the rules behind them, and signed webhooks.
Send and manage
- The protocol the SDKs speak, for your own client.
- OpenTelemetry traces over HTTP.
- Register a release and upload its source maps.
- Projects, ingest keys, API tokens and usage.