Docs

Projects, keys and tokens

Create projects, ingest keys and API tokens on a self-hosted engine, manage keys and tokens anywhere, and read usage.

Applies to EngineCloud At launch

View as Markdown
On this page
  1. The project object
  2. The ingest key object
  3. The API token object
  4. List projects
  5. Create a project
  6. Get a project
  7. Update a project
  8. Delete a project
  9. List ingest keys
  10. Create an ingest key
  11. Revoke an ingest key
  12. List API tokens
  13. Create an API token
  14. Revoke an API token
  15. Get usage and limits

The engine knows three things about access: projects, ingest keys and API tokens. It has no users and no organizations. Those exist only in Sypnia Cloud, in the app, and have no public API at launch.

You want toEngine (self-hosted)Sypnia Cloud
Create or delete a projectThis API, with the root tokenIn the app
Create or revoke ingest keys and API tokensThis API, with the root token or an admin token of the projectThis API with an admin token, or in the app
Invite people, change plan, see invoicesDoes not existIn the app

The project object

Fields

  • id
    string optional

    prj_….

  • slug
    string optional

    A short name for URLs and commands. Lowercase letters, digits and hyphens, 2 to 40 characters. Cannot be changed.

  • name
    string optional

    The name people see.

  • timezone
    string optional

    An IANA time zone. Days, «today» and «yesterday» are cut in it.

  • environments
    array of string optional

    The environments that sent data in the last 30 days.

  • settings
    object optional
  • settings.allowed_origins
    array of string, up to 50 items

    Origins allowed to send browser data, such as https://shop.example.com. A leading *. matches subdomains. Empty accepts any origin.

  • settings.replay
    object

    Recording rules. The SDK reads them from the ingest’s config call.

  • settings.replay.enabled
    boolean

    false switches replay off for the project.

    Default: true

  • settings.replay.sample_rate
    number, 0 to 1

    The share of sessions recorded from their first moment. Sessions outside it are still recorded from 30 seconds before their first error, rage click or dead click.

    Default: 0.1

  • settings.replay.mask_all_text
    boolean

    true masks every text on the page, not only what people type. What people type is always masked, and password, card and one-time-code fields can never be unmasked.

    Default: false

  • settings.replay.blocked_routes
    array of string, up to 100 items

    Routes where nothing is recorded and no snapshot is taken. * matches any characters: /account/*.

  • settings.replay.always_record
    array of object, up to 100 items

    People and accounts whose sessions are always recorded from the start, for example while you help a customer.

  • settings.snapshots
    object
  • settings.snapshots.sample_rate
    number, 0 to 1

    The share of sessions that take page snapshots, for click maps.

    Default: 0.5

  • settings.agent
    object
  • settings.agent.enabled
    boolean

    false switches the agent off for this project: no analysis, no weekly suggestions from a model. Nothing is sent to an AI provider.

    Default: true

  • settings.agent.language
    string

    The language the agent writes in, as a BCP 47 tag (en, es).

    Default: en

  • settings.agent.auto_pull_requests
    string

    Sypnia Cloud only. high_confidence opens a pull request by itself when an analysis is high. One of: off, high_confidence.

    Default: off

  • created_at
    timestamp optional

The ingest key object

Fields

  • id
    string optional

    The record’s id, key_…. Use it to revoke the key.

  • key
    string optional

    The key itself, spk_ and 32 hex characters. Public: it goes in your app’s code.

  • name
    string optional
  • rate_limit_per_minute
    integer optional

    Requests per minute accepted from one address with this key.

  • created_at
    timestamp optional
  • last_used_at
    timestamp or null optional

    Accurate to the hour.

  • revoked_at
    timestamp or null optional

The API token object

Fields

  • id
    string optional

    The record’s id, tok_…. Use it to revoke the token.

  • name
    string optional
  • prefix
    string optional

    The first 12 characters of the secret.

  • scopes
    array of string optional

    One of: read, replay, admin.

  • created_at
    timestamp optional
  • last_used_at
    timestamp or null optional

    Accurate to the hour.

  • expires_at
    timestamp or null optional
  • revoked_at
    timestamp or null optional

List projects

GET /v1/projects EngineCloud

With the root token, every project of the engine. With an API token, a list with the one project the token belongs to.

Authentication
Root token, or API token (read)

Query parameters

  • limit
    integer, 1 to 200 optional

    Most items to return.

    Default: 50

  • cursor
    string optional

    The next_cursor of the previous page. Keep every other parameter the same.

Request

Terminal
curl "https://sypnia.example.com/v1/projects" \
  -H "Authorization: Bearer $SYPNIA_ROOT_TOKEN"

Response200

JSON
{
  "data": [
    {
      "id": "prj_5k2m9x4q7w1z",
      "slug": "shop",
      "name": "Shop",
      "timezone": "UTC",
      "environments": [
        "production",
        "development"
      ],
      "settings": {
        "allowed_origins": [
          "https://shop.example.com"
        ],
        "replay": {
          "enabled": true,
          "sample_rate": 0.1,
          "mask_all_text": false,
          "blocked_routes": [
            "/account/cards"
          ],
          "always_record": [
            {
              "person": "u_1042",
              "note": "Reported the checkout bug",
              "until": "2026-03-26T00:00:00Z"
            }
          ]
        },
        "snapshots": {
          "sample_rate": 0.5
        },
        "agent": {
          "enabled": true,
          "language": "en",
          "auto_pull_requests": "off"
        }
      },
      "created_at": "2026-02-02T09:15:00Z"
    }
  ],
  "next_cursor": null
}

Create a project

POST /v1/projects Engine

Creates a project and its first ingest key, which comes back in ingest_key. Self-hosted engines only: on Sypnia Cloud projects are created in the app, where they belong to an organization and a plan, and this call answers 403 cloud_managed.

Authentication
Root token

Headers

  • Idempotency-Key
    string, up to 255 characters optional

    A value of your own, 1 to 255 characters, that makes the call safe to repeat. See idempotency.

Body

  • name
    string, up to 80 characters required

    The name people see.

  • slug
    string optional

    Defaults to the name in lowercase with hyphens.

  • timezone
    string optional

    An IANA time zone, such as America/Bogota.

    Default: UTC

  • settings
    object optional
  • settings.allowed_origins
    array of string, up to 50 items

    Origins allowed to send browser data, such as https://shop.example.com. A leading *. matches subdomains. Empty accepts any origin.

  • settings.replay
    object

    Recording rules. The SDK reads them from the ingest’s config call.

  • settings.replay.enabled
    boolean

    false switches replay off for the project.

    Default: true

  • settings.replay.sample_rate
    number, 0 to 1

    The share of sessions recorded from their first moment. Sessions outside it are still recorded from 30 seconds before their first error, rage click or dead click.

    Default: 0.1

  • settings.replay.mask_all_text
    boolean

    true masks every text on the page, not only what people type. What people type is always masked, and password, card and one-time-code fields can never be unmasked.

    Default: false

  • settings.replay.blocked_routes
    array of string, up to 100 items

    Routes where nothing is recorded and no snapshot is taken. * matches any characters: /account/*.

  • settings.replay.always_record
    array of object, up to 100 items

    People and accounts whose sessions are always recorded from the start, for example while you help a customer.

  • settings.snapshots
    object
  • settings.snapshots.sample_rate
    number, 0 to 1

    The share of sessions that take page snapshots, for click maps.

    Default: 0.5

  • settings.agent
    object
  • settings.agent.enabled
    boolean

    false switches the agent off for this project: no analysis, no weekly suggestions from a model. Nothing is sent to an AI provider.

    Default: true

  • settings.agent.language
    string

    The language the agent writes in, as a BCP 47 tag (en, es).

    Default: en

  • settings.agent.auto_pull_requests
    string

    Sypnia Cloud only. high_confidence opens a pull request by itself when an analysis is high. One of: off, high_confidence.

    Default: off

Request

Terminal
curl -X POST "https://sypnia.example.com/v1/projects" \
  -H "Authorization: Bearer $SYPNIA_ROOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Shop", "slug": "shop", "timezone": "UTC"}'

Response201

JSON
{
  "id": "prj_5k2m9x4q7w1z",
  "slug": "shop",
  "name": "Shop",
  "timezone": "UTC",
  "environments": [],
  "settings": {
    "allowed_origins": [],
    "replay": {
      "enabled": true,
      "sample_rate": 0.1,
      "mask_all_text": false,
      "blocked_routes": [],
      "always_record": []
    },
    "snapshots": {
      "sample_rate": 0.5
    },
    "agent": {
      "enabled": true,
      "language": "en",
      "auto_pull_requests": "off"
    }
  },
  "created_at": "2026-02-02T09:15:00Z",
  "ingest_key": {
    "id": "key_3n8v2c6b1m4x",
    "key": "spk_7d1f0c9e4b8a2f6d3c5e1a9b0f4d8c2e",
    "name": "Default",
    "rate_limit_per_minute": 600,
    "created_at": "2026-02-02T09:15:00Z",
    "last_used_at": null,
    "revoked_at": null
  }
}

Errors

  • 400invalid_request

    name is missing, slug has characters other than a-z 0-9 -, or timezone is not an IANA name.

  • 403cloud_managed

    The request went to Sypnia Cloud. Create projects in the app.

  • 403forbidden

    The credential is not the root token.

  • 409conflict

    A project with this slug exists.

Get a project

GET /v1/projects/{project_ref} EngineCloud

One project with its settings.

Authentication
Root token, or API token (read) of that project

Path parameters

  • project_ref
    string required

    The project’s id (prj_…) or slug.

Request

Terminal
curl "https://api.sypnia.com/v1/projects/shop" \
  -H "Authorization: Bearer $SYPNIA_API_TOKEN"

Response200

JSON
{
  "id": "prj_5k2m9x4q7w1z",
  "slug": "shop",
  "name": "Shop",
  "timezone": "UTC",
  "environments": [
    "production",
    "development"
  ],
  "settings": {
    "allowed_origins": [
      "https://shop.example.com"
    ],
    "replay": {
      "enabled": true,
      "sample_rate": 0.1,
      "mask_all_text": false,
      "blocked_routes": [
        "/account/cards"
      ],
      "always_record": [
        {
          "person": "u_1042",
          "note": "Reported the checkout bug",
          "until": "2026-03-26T00:00:00Z"
        }
      ]
    },
    "snapshots": {
      "sample_rate": 0.5
    },
    "agent": {
      "enabled": true,
      "language": "en",
      "auto_pull_requests": "off"
    }
  },
  "created_at": "2026-02-02T09:15:00Z"
}

Errors

  • 404not_found

    No such project, or the token belongs to another one.

Update a project

PATCH /v1/projects/{project_ref} EngineCloud

Changes the fields you send and leaves the rest. settings is merged key by key: send only the settings you want to change. Recording rules (settings.replay, settings.snapshots) reach browsers with their next session, through the ingest’s config call; no deploy is needed.

Authentication
Root token, or API token (admin) of that project

Path parameters

  • project_ref
    string required

    The project’s id (prj_…) or slug.

Body

  • name
    string, up to 80 characters optional

    The name people see.

  • timezone
    string optional

    An IANA time zone. Past days are not recut.

  • settings
    object optional
  • settings.allowed_origins
    array of string, up to 50 items

    Origins allowed to send browser data, such as https://shop.example.com. A leading *. matches subdomains. Empty accepts any origin.

  • settings.replay
    object

    Recording rules. The SDK reads them from the ingest’s config call.

  • settings.replay.enabled
    boolean

    false switches replay off for the project.

    Default: true

  • settings.replay.sample_rate
    number, 0 to 1

    The share of sessions recorded from their first moment. Sessions outside it are still recorded from 30 seconds before their first error, rage click or dead click.

    Default: 0.1

  • settings.replay.mask_all_text
    boolean

    true masks every text on the page, not only what people type. What people type is always masked, and password, card and one-time-code fields can never be unmasked.

    Default: false

  • settings.replay.blocked_routes
    array of string, up to 100 items

    Routes where nothing is recorded and no snapshot is taken. * matches any characters: /account/*.

  • settings.replay.always_record
    array of object, up to 100 items

    People and accounts whose sessions are always recorded from the start, for example while you help a customer.

  • settings.snapshots
    object
  • settings.snapshots.sample_rate
    number, 0 to 1

    The share of sessions that take page snapshots, for click maps.

    Default: 0.5

  • settings.agent
    object
  • settings.agent.enabled
    boolean

    false switches the agent off for this project: no analysis, no weekly suggestions from a model. Nothing is sent to an AI provider.

    Default: true

  • settings.agent.language
    string

    The language the agent writes in, as a BCP 47 tag (en, es).

    Default: en

  • settings.agent.auto_pull_requests
    string

    Sypnia Cloud only. high_confidence opens a pull request by itself when an analysis is high. One of: off, high_confidence.

    Default: off

Request

Terminal
curl -X PATCH "https://api.sypnia.com/v1/projects/shop" \
  -H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"settings": {"replay": {"blocked_routes": ["/account/cards"]}}}'

Response200

JSON
{
  "id": "prj_5k2m9x4q7w1z",
  "slug": "shop",
  "name": "Shop",
  "timezone": "UTC",
  "environments": [
    "production",
    "development"
  ],
  "settings": {
    "allowed_origins": [
      "https://shop.example.com"
    ],
    "replay": {
      "enabled": true,
      "sample_rate": 0.1,
      "mask_all_text": false,
      "blocked_routes": [
        "/account/cards"
      ],
      "always_record": [
        {
          "person": "u_1042",
          "note": "Reported the checkout bug",
          "until": "2026-03-26T00:00:00Z"
        }
      ]
    },
    "snapshots": {
      "sample_rate": 0.5
    },
    "agent": {
      "enabled": true,
      "language": "en",
      "auto_pull_requests": "off"
    }
  },
  "created_at": "2026-02-02T09:15:00Z"
}

Errors

  • 400invalid_request

    A setting is out of range or unknown. param names it, for example settings.replay.sample_rate.

  • 404not_found

    No such project, or the token belongs to another one.

Delete a project

DELETE /v1/projects/{project_ref} Engine

Deletes the project, its keys and tokens, and all of its data, for good. Ingest for its keys stops at once; stored objects are removed within 24 hours. Self-hosted engines only. To confirm, send the project’s slug in the confirm query parameter.

Authentication
Root token

Path parameters

  • project_ref
    string required

    The project’s id (prj_…) or slug.

Query parameters

  • confirm
    string required

    The project’s slug, typed again.

Request

Terminal
curl -X DELETE "https://sypnia.example.com/v1/projects/shop?confirm=shop" \
  -H "Authorization: Bearer $SYPNIA_ROOT_TOKEN"

Errors

  • 400invalid_request

    confirm is missing or is not the project’s slug.

  • 403cloud_managed

    The request went to Sypnia Cloud. Delete projects in the app.

  • 404not_found

    No such project.

List ingest keys

GET /v1/keys EngineCloud

The project’s ingest keys, including revoked ones. An ingest key is public, so the list shows each key in full.

Authentication
Root token, or API token (admin)

Query parameters

  • project
    string optional

    The project’s id or slug. Needed only with a credential that can see several projects (the root token). With an API token it is ignored unless it names another project, which is 403.

Request

Terminal
curl "https://api.sypnia.com/v1/keys" \
  -H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN"

Response200

JSON
{
  "data": [
    {
      "id": "key_3n8v2c6b1m4x",
      "key": "spk_7d1f0c9e4b8a2f6d3c5e1a9b0f4d8c2e",
      "name": "Web app",
      "rate_limit_per_minute": 600,
      "created_at": "2026-02-02T09:15:00Z",
      "last_used_at": "2026-03-12T10:31:58Z",
      "revoked_at": null
    }
  ],
  "next_cursor": null
}

Create an ingest key

POST /v1/keys EngineCloud

Creates another ingest key for the project. Give each app or platform its own key (web, mobile, server), so you can revoke one without stopping the others. A project has at most 20 keys that are not revoked.

Authentication
Root token, or API token (admin)

Query parameters

  • project
    string optional

    The project’s id or slug. Needed only with a credential that can see several projects (the root token). With an API token it is ignored unless it names another project, which is 403.

Headers

  • Idempotency-Key
    string, up to 255 characters optional

    A value of your own, 1 to 255 characters, that makes the call safe to repeat. See idempotency.

Body

  • name
    string, up to 80 characters required

    What the key is for.

  • rate_limit_per_minute
    integer, 10 to 6,000 optional

    Requests per minute accepted from one address with this key. Raise it for a server that sends for many people from one address.

    Default: 600

Request

Terminal
curl -X POST "https://api.sypnia.com/v1/keys" \
  -H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Checkout API"}'

Response201

JSON
{
  "id": "key_8b5n2m7v4c1x",
  "key": "spk_a3c9e1f7b5d2084c6e0a9f3b7d1c5e82",
  "name": "Checkout API",
  "rate_limit_per_minute": 600,
  "created_at": "2026-03-12T10:40:00Z",
  "last_used_at": null,
  "revoked_at": null
}

Errors

  • 409limit_reached

    The project already has 20 keys that are not revoked.

Revoke an ingest key

DELETE /v1/keys/{key_id} EngineCloud

Revokes the key. Ingest with it answers 401 within one minute. The record stays in the list with revoked_at. Revoking cannot be undone; create a new key instead.

Authentication
Root token, or API token (admin)

Path parameters

  • key_id
    string required

    The key’s record id (key_…), not the key itself.

Query parameters

  • project
    string optional

    The project’s id or slug. Needed only with a credential that can see several projects (the root token). With an API token it is ignored unless it names another project, which is 403.

Request

Terminal
curl -X DELETE "https://api.sypnia.com/v1/keys/key_8b5n2m7v4c1x" \
  -H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN"

Errors

  • 404not_found

    No key has this id in the project.

  • 409conflict

    It is the project’s last key that is not revoked. Create another first, so your app is never without one.

List API tokens

GET /v1/tokens EngineCloud

The project’s API tokens, including revoked and expired ones. The secret is never shown again; prefix is its first 12 characters, enough to recognise it.

Authentication
Root token, or API token (admin)

Query parameters

  • project
    string optional

    The project’s id or slug. Needed only with a credential that can see several projects (the root token). With an API token it is ignored unless it names another project, which is 403.

Request

Terminal
curl "https://api.sypnia.com/v1/tokens" \
  -H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN"

Response200

JSON
{
  "data": [
    {
      "id": "tok_9r4t6y2u8i1o",
      "name": "Cursor",
      "prefix": "sps_4Kq9Zt2M",
      "scopes": [
        "read",
        "replay"
      ],
      "created_at": "2026-02-02T09:18:00Z",
      "last_used_at": "2026-03-12T10:34:10Z",
      "expires_at": null,
      "revoked_at": null
    }
  ],
  "next_cursor": null
}

Create an API token

POST /v1/tokens EngineCloud

Creates an API token for the project. The secret is in token and is shown only in this answer: the engine stores a hash of it. Give a token the fewest scopes that do the job:

ScopeWhat it allows
readRead everything except replay content. Its only writes are reversible marks: resolve or reopen a problem, acknowledge an alert, set a suggestion’s status
replayFetch replays and page snapshots. They show the page as the person saw it
adminEverything that changes the project: keys, tokens, settings, releases and source maps, uptime checks, alert rules, webhooks, ignoring a problem, deleting data

Scopes do not include each other: a token that should read and manage needs read and admin.

Authentication
Root token, or API token (admin)

Query parameters

  • project
    string optional

    The project’s id or slug. Needed only with a credential that can see several projects (the root token). With an API token it is ignored unless it names another project, which is 403.

Headers

  • Idempotency-Key
    string, up to 255 characters optional

    A value of your own, 1 to 255 characters, that makes the call safe to repeat. See idempotency.

Body

  • name
    string, up to 80 characters required

    Who or what will use it. It appears in resolved_by and in the audit of changes.

  • scopes
    array of string required

    What the token may do. One of: read, replay, admin.

  • expires_at
    timestamp optional

    When the token stops working. Leave it out for a token that does not expire.

Request

Terminal
curl -X POST "https://api.sypnia.com/v1/tokens" \
  -H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Cursor", "scopes": ["read", "replay"]}'

Response201

JSON
{
  "id": "tok_9r4t6y2u8i1o",
  "name": "Cursor",
  "prefix": "sps_4Kq9Zt2M",
  "token": "sps_4Kq9Zt2MxV7bN1cR5wY8pL3dF6hJ0sA2gE4uT9iO",
  "scopes": [
    "read",
    "replay"
  ],
  "created_at": "2026-02-02T09:18:00Z",
  "last_used_at": null,
  "expires_at": null,
  "revoked_at": null
}

Errors

  • 400invalid_request

    scopes is empty or has a value other than read, replay, admin; or expires_at is in the past.

  • 409limit_reached

    The project already has 50 tokens that are not revoked.

Revoke an API token

DELETE /v1/tokens/{token_id} EngineCloud

Revokes the token. Requests with it answer 401 within one minute. A token may revoke itself.

Authentication
Root token, or API token (admin)

Path parameters

  • token_id
    string required

    The token’s record id (tok_…), not the secret.

Query parameters

  • project
    string optional

    The project’s id or slug. Needed only with a credential that can see several projects (the root token). With an API token it is ignored unless it names another project, which is 403.

Request

Terminal
curl -X DELETE "https://api.sypnia.com/v1/tokens/tok_9r4t6y2u8i1o" \
  -H "Authorization: Bearer $SYPNIA_ADMIN_TOKEN"

Errors

  • 404not_found

    No token has this id in the project.

Get usage and limits

GET /v1/usage EngineCloud

What the project used in the current period and what its limits are. A limit of null means no limit: that is every limit on a self-hosted engine unless you set a quota in its configuration. On Sypnia Cloud the limits are the plan’s and the period is the calendar month, in UTC. A plan’s limits belong to the organization and are shared by its projects: used is this project’s part, organization_used is what all its projects used together, and the limit is reached when organization_used reaches limit.

Counters are exact and updated as data arrives. dropped_over_limit is how many events or replays were refused because a limit was reached: Sypnia never drops silently, it counts here and tells the SDK to slow down.

CounterWhat counts as one
eventsAn error, a trace (one request with its spans) or a performance sample (a page view with its vitals). Clicks, custom events and replay chunks do not count
replaysA session that has a recording
analysesOne run of the agent on one problem. Counted per day
pull_requestsA pull request opened by Sypnia. Sypnia Cloud only
Authentication
API token (read)

Query parameters

  • project
    string optional

    The project’s id or slug. Needed only with a credential that can see several projects (the root token). With an API token it is ignored unless it names another project, which is 403.

  • period
    string optional

    A month as YYYY-MM, to read a past period. Up to 12 months back.

Request

Terminal
curl "https://api.sypnia.com/v1/usage" \
  -H "Authorization: Bearer $SYPNIA_API_TOKEN"

Response200

JSON
{
  "project": {
    "id": "prj_5k2m9x4q7w1z",
    "slug": "shop",
    "name": "Shop"
  },
  "plan": "builder",
  "period": {
    "start": "2026-03-01T00:00:00Z",
    "end": "2026-04-01T00:00:00Z"
  },
  "events": {
    "used": 18240,
    "organization_used": 21902,
    "limit": 50000,
    "dropped_over_limit": 0
  },
  "replays": {
    "used": 212,
    "organization_used": 240,
    "limit": 500,
    "dropped_over_limit": 0
  },
  "analyses": {
    "used_today": 4,
    "limit_per_day": 100,
    "used_this_period": 37
  },
  "pull_requests": {
    "used": 6,
    "organization_used": 6,
    "limit": 50,
    "dropped_over_limit": 0
  },
  "uptime_checks": {
    "used": 1,
    "limit": 5
  },
  "retention_days": {
    "events": 30,
    "replays": 30
  },
  "slow_down": null,
  "daily": [
    {
      "day": "2026-03-11",
      "events": 1610,
      "replays": 19,
      "analyses": 2
    },
    {
      "day": "2026-03-12",
      "events": 702,
      "replays": 9,
      "analyses": 4
    }
  ]
}

The errors every endpoint can answer (401, 403, 429, 500, 503) are on Errors, limits, pagination.

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