Docs

Reference

The pages you look things up in, from the event schema and the glossary to what is planned, the changelog and the common questions.

Applies to EngineCloud At launch

View as Markdown
On this page
  1. The other references
  2. For coding agents

This section is for looking things up. Its pages apply to the open-source engine Engine and to Sypnia Cloud Cloud, and each says where the two differ.

  • Event schema

    Every event the SDKs send, field by field, with types, limits and an example of each, and the rules the engine applies to them.

  • Glossary

    Every word Sypnia uses with a fixed meaning, defined in one or two sentences, with the name it has in the API and in Spanish.

  • Planned

    The honest list of what Sypnia does not do at launch, in three groups: what is planned, what is absent with no promise, and what Sypnia will not do by design. No dates.

  • Changelog

    Where every release of the engine, the SDKs, the MCP package, the skills and Sypnia Cloud will be listed, how an entry is written, and what the version numbers promise.

  • FAQ

    Short answers to the questions people ask before and after they install Sypnia, each with a link to the page that has the whole answer.

The other references

Four references are large enough to have a section of their own. Like the event schema, each is generated from a machine-readable contract in spec/, so the page and the contract cannot drift apart.

ReferenceWhat it listsContract
API referenceEvery endpoint, parameter, response and errorspec/openapi.yaml
CLI referenceEvery command and flag of sypniaspec/cli.yaml
MCP toolsEvery tool a coding agent can callspec/mcp.json
Configuration reference EngineEvery setting of a self-hosted enginespec/config.yaml
Event schemaEvery event the SDKs sendspec/events.schema.json

For coding agents

Every page of these docs is also served as Markdown: add .md to its address. The whole documentation in one file is at /llms-full.txt, and its map at /llms.txt. Before you tell someone that Sypnia does something, check Planned: it lists what does not exist at launch.

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