Skip to main content

Authentication

How to securely authenticate your requests with BlitzAPI.
Agents & LLMs: a Markdown version of this page is available by appending .md to the URL, and the full documentation index is at llms.txt.
BlitzAPI uses API Keys to authenticate requests. You can view and manage your API keys in the BlitzAPI Dashboard.

The x-api-key Header

Authentication to the API is handled via an HTTP header. Include your API key in every request using the x-api-key header.
Security Warning: Your API keys carry many privileges. Do not use your API keys in client-side code (browsers, mobile apps).Always route requests through your own backend server to keep your keys secret.

Example Request

Here is how to set the header in various environments:

Verifying your Key

To check if your key is active, use the GET /v2/account/key-info endpoint. This is a great way to “health check” your integration before running batch jobs.
Response:
Response Fields:

Errors

If authentication fails, the API will return a 401 Unauthorized error.