# 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: the Sypnia engine (open source, self-hosted) and Sypnia Cloud (paid service). Status: at launch.  
Source: https://docs.sypnia.com/reference/

For agents: Section index for Sypnia's reference pages: the event schema (every event field by field), the glossary (one name per thing), Planned (everything that does not exist at launch), the changelog, and the FAQ. The API, the CLI, the MCP tools and the engine's settings have their own reference sections.

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](/reference/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](/reference/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](/reference/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](/reference/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](/reference/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.

| Reference                                                                                   | What it lists                                 | Contract                  |
| ------------------------------------------------------------------------------------------- | --------------------------------------------- | ------------------------- |
| [API reference](https://docs.sypnia.com/api)                                                | Every endpoint, parameter, response and error | `spec/openapi.yaml`       |
| [CLI reference](https://docs.sypnia.com/cli)                                                | Every command and flag of `sypnia`            | `spec/cli.yaml`           |
| [MCP tools](https://docs.sypnia.com/mcp/tools-reference)                                    | Every tool a coding agent can call            | `spec/mcp.json`           |
| [Configuration reference](https://docs.sypnia.com/self-hosting/configuration) **\[Engine]** | Every setting of a self-hosted engine         | `spec/config.yaml`        |
| [Event schema](https://docs.sypnia.com/reference/event-schema)                              | Every event the SDKs send                     | `spec/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](https://docs.sypnia.com/reference/planned): it lists what does not exist at launch.
