API Specs
Machine-readable specifications for everything in the Getting Started guide, for use with code generators, API clients, test tools, and AI assistants.
| Spec | Format | Covers |
|---|---|---|
| openapi.json | OpenAPI 3.1 | POST /v1/tickets and the match-made webhook. |
| asyncapi.json | AsyncAPI 3.0 | The WebSocket messages between your game client and Pairiquium. |
Both are served from this site and always match what is currently deployed.
Building in Unity? The Unity SDK implements these specs, so you don't need to work with them directly.
Specs describe shapes, guides describe behaviour
The specs give the exact fields of every request and message. They can't express ordering or timing, such as ticket expiry, heartbeats, or what happens when a connection drops. For that, follow the step-by-step guides, or read the protocol overview.
Pinning a version
Every release of the specs is tagged in the public
API-Specs repository (v1.0.0, and so on), and the
version is also in each file's info.version. If you generate a client from the specs, pin it to a
tagged version rather than the live URL so a new release doesn't change your generated code
unexpectedly.
Additive changes, such as new optional fields, don't break existing integrations: ignore any fields you don't recognise. Anything that could break an existing integration is a new major version.