> ## Documentation Index
> Fetch the complete documentation index at: https://synapse-docs.apart.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Schema reference

> Understand the canonical request, response, event, and error models exposed by Synapse.

# Schema reference

The canonical OpenAPI document defines 167 JSON schemas for tenant resources,
participant sessions, evaluations, reports, webhooks, analytics, errors, and
pagination.

Generated endpoint pages display the exact request and response schemas used by
each operation. Use the downloadable [OpenAPI document](/openapi.json) when you
need to:

* Generate a client for another language.
* Inspect shared enums, unions, validation limits, and nullable fields.
* Validate webhook or event payloads in CI.
* Compare a release artifact with the TypeScript and Python SDK models.

## Common models

| Area         | Representative schemas                                                                                  |
| ------------ | ------------------------------------------------------------------------------------------------------- |
| Subjects     | `SubjectUpsertRequest`, `SubjectUpsertResponse`, `SubjectSummary`, `SubjectPage`                        |
| Programs     | `ProgramCreate`, `Program`, `ProgramPage`, `ProgramStatusTransition`                                    |
| Participants | `ParticipantSessionCreate`, `ParticipantSessionCreated`, `ParticipantSessionState`, `ParticipantReport` |
| Evaluations  | `EvaluationSummary`, `EvaluationResult`, `EvaluationRelease`, `EvaluationDrift`                         |
| Reports      | `ReportShareCreate`, `ReportShare`, `ReportShareRevoked`                                                |
| Errors       | `ApiErrorResponse`, `ErrorDetail`, `HTTPValidationError`                                                |

<Warning>
  Do not assume a field is available to every actor merely because it appears in
  an internal schema. Participant-safe and report-share endpoints return reduced
  views; EngineTrace and contribution details require authorized internal access.
</Warning>