Skip to main content
One key works on api.raze.bot, ws.raze.bot and router.raze.bot (the router and launch). On the API every route except /, /health and /openapi.yaml needs it; on the router every route except /health, /ready, /evm/health and /evm/ready. The API reads it from the first of these that is present, and checks only that one (a wrong x-api-key fails even next to a right Authorization header):
  1. Header x-api-key: <key>
  2. Header Authorization: Bearer <key> (bearer works too)
  3. Query ?apiKey=<key> (?api_key= works too)
A missing or unknown key answers 401:

WebSocket and SSE

Browsers cannot set headers on a WebSocket or an EventSource, so both take the key in the URL. The WebSocket checks it before the upgrade: a bad key never becomes a socket.
Server-side clients (Node, Python, Go) can send x-api-key on the upgrade request instead.

Playground

The interactive playground in these docs sends x-api-key. Paste the raw key.

Key hygiene

  • Keep keys on your server, in environment variables. A key in a browser bundle or a page URL is a public key.
  • For a web app, proxy REST and the WebSocket through your backend and add the key there.
  • Limits are per key, and the keys of one account share the account’s limit: see Rate limits.