ticket.js use this API. You can use it too, with curl or a script on the same computer.
The endpoint pages in this tab come from docs/openapi.json in the Building58 repo, an OpenAPI 3.1 document. Its info.version is the API version. The description of each route comes from The relay API and routes in the technical manual.
The relay answers your computer only, at
http://localhost:8787, where npm run office starts it. So these pages show each request and response, but they have no button to send a request.Channels
All routes exceptGET /health are under /channels/{channel}. A channel joins callers to one world page on the relay. The room uses office by default. Each channel is a separate room, with its own sessions and tickets.
Authentication
Most routes need one of these:GET /health needs no key.
The routes that can run commands answer only the room page on your computer, with the key. A tunnel, another website or another computer gets 403, even with the key. See Safety and permissions.
A first call
Check that the relay is up
List the tickets, with the relay key in RELAY_KEY
Errors
A refused call returns JSON withok: false, a short error code such as bad_param, forbidden or not_found, and a message in plain words.
For events, webhooks,
ticket.js and games, see The relay API and routes in the technical manual.