API Keys
All API requests (except /health) require authentication using an API key. You can authenticate in two ways:
Option 1: Header (Recommended)
Code
Option 2: Query Parameter
Code
Getting an API Key
The API is currently in closed beta. There is no self-service signup. To request access and an API key, submit a request via the Request Access page:
- Visit the Request Access page and complete the form with your name, organization, intended use, and contact email.
- After submitting, you will receive an acknowledgement email and we will review your request.
- If approved, you'll receive instructions by email (and access will be added to your dashboard) with details on how to retrieve your API key.
Using API Keys
Include your API key in the X-API-Key header or as the api_key query parameter for every request:
Code
Example with cURL
Code
Example with Python
Code
Example with JavaScript
Code
Security
- Never commit API keys to version control
- Rotate keys regularly
- Use environment variables for API keys in production
- Report compromised keys immediately
Error Handling
If you receive a 401 Unauthorized error:
- Verify your API key is correct
- Check the
X-API-Keyheader orapi_keyquery parameter is present - Ensure the key hasn't expired
- Generate a new key if needed