Trying the API from the docs

What the API reference at docs.blockoutgames.com is, what Try it sends and where, what happens to the key you type, and what a request costs.

Get started

The API reference shows every route of the developer API with its parameters and answers, and its Try it sends a real request from your browser to https://studio.blockoutgames.com/developer/v1/... with the bk_live_ key you type into the page. The key stays in the page's memory: it is not saved, not logged by the docs site, and sent nowhere else.

What the API reference is

The reference is drawn by the docs site itself from the developer API's OpenAPI 3.1 document, one page per route, in the same layout as these guides, which anyone can download at docs.blockoutgames.com/openapi.json and load into their own tools. The document is checked against the platform's contracts, and a test sends every example in it to the API and checks the answer, so what the reference shows is what the API answers.

How to try a route

  1. Open the reference

    Open the API reference and choose a route under Endpoints, such as The game the key opens (GET /key).

  2. Open Try it

    Choose Try it at the end of the route's request bar.

  3. Type the key

    Paste the game's key into Game key (Bearer), and change the parameters if you want. Get it from the game's Developer tab (Getting a game's API key).

  4. Send it

    Choose Send request. The answer appears under it, with its status and how long it took.

Without a key the API answers 401 unauthenticated, as it does for a game server without one.

Where the request goes

The request goes from your browser straight to https://studio.blockoutgames.com/developer/v1/..., the same address a game's servers use. Nothing passes through the docs site or a third party.

  • The page can reach nothing else. The docs site's Content Security Policy lets a page connect only to the docs site itself, Cloudflare's analytics beacon and studio.blockoutgames.com.

  • The studio answers this site only. The panel answers cross-origin requests (CORS) to /developer/v1 for https://docs.blockoutgames.com and no other site: GET and POST, with the authorization and content-type headers, and never with cookies. The browser's preflight question is answered by the panel itself and never reaches the API.

What happens to the key you type

  • It is held in the page's memory only. It is never written to the browser's storage, a cookie or the address, and the field asks the browser not to remember it.

  • The docs site never receives it, so it cannot log it.

  • It is sent only as the Authorization: Bearer header of the requests you send.

  • Reloading or closing the tab forgets it.

If you pasted the key anywhere you should not have, such as a chat or a shared screen, rotate it on the game's Developer tab (Rotate a key) and update the game's secret.

What a request from Try it costs

A request from Try it is a real request with the game's key. It counts against the key exactly like a game server's: the key's 120 requests a minute, shared with every server of the game, and the usage counts on the game's Developer tab. See Errors, limits and polling.

Updated