API reference

Every route of the API, grouped by tag, with parameters, request bodies, responses and samples in curl, JavaScript and Python. The reference pages are generated at build time from apps/api/openapi.yaml, the file the API runs on, so what you read here is what the API answers.

Start with the introduction pages, then the group that matches what you build.

• Authentication: the four credentials and where each one is valid.
• Errors: the { error, message } shape and every code.
• Rate limits: what is limited, by what, and the 429 answer.
• Versioning: the /v1 prefix and how the API changes.
• CORS and origins: which origins may call the API from a browser and frame a game.

The reference itself:

• SDK: what a game or a hub calls with a player or game token: players, sessions, saves, leaderboards, events.
• Catalog and Bundles: public, cacheable.
• Account: sign-in by link, code or password, export, deletion.
• Community and Feedback: ratings, comments, bug reports.
• Console: sign-in to the developer console, invitations, sessions.
• Admin: the console API, for developers and staff, on the session cookie.
• Server: for portal backends, on a server key.
• Schemas: every named object the routes read or answer.

A route heading is a link: /docs/api/reference/sdk/#post-v1-sdk-game-tokens opens POST /v1/sdk/game-tokens. The anchor is the method and the path, lowercase, with dashes.