Documentation Index
Fetch the complete documentation index at: https://docs.blitz-api.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authentication
How to securely authenticate your requests with BlitzAPI.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.
Example Request
Here is how to set the header in various environments:Verifying your Key
To check if your key is active, use theGET /v2/account/key-info endpoint. This is a great way to “health check” your integration before running batch jobs.
Response:
| Field | Type | Description |
|---|---|---|
valid | boolean | true if the key is active and can make requests. |
id | string | Internal identifier for your API key. |
remaining_credits | number | Remaining usage allowance. Relevant for trial accounts only — paid plans are unlimited. |
next_reset_at | string | ISO 8601 timestamp of when your allowance resets. |
max_requests_per_seconds | integer | Your plan’s rate limit. Use this value to configure your rate limiter client-side. |
allowed_apis | array | List of endpoint paths your key is authorized to call. |
active_plans | array | Your active subscription(s) with name, status, and start date. |
Errors
If authentication fails, the API will return a401 Unauthorized error.
| Code | Meaning | Solution |
|---|---|---|
401 | Unauthorized | Missing or invalid API key. Check that the x-api-key header is present and correct. |
402 | Payment Required | Your key is valid, but your account has reached its limit. Upgrade your plan. |
404 | Not Found | The API Key provided does not exist in our system. |

