Creating an API Key
1
Open API Keys
Navigate to the API Keys section in your organisation’s dashboard.
2
Generate a key
Click Create Key, give it a descriptive name (e.g.
production, staging), and confirm.3
Copy your key
Your full API key is shown once at creation. Copy it and store it somewhere secure.
Using Your API Key
Include your API key in theX-API-Key header on every request.
Managing Keys
From the API Keys page you can:- Rename a key to keep your list organised
- Revoke a key to immediately disable it. Any requests using that key will return
401 Unauthorized
There is no limit on the number of API keys per organisation. Use separate keys for different environments or services so you can revoke them independently.
Security Best Practices
- Never expose API keys in client-side code or public repositories
- Use environment variables or a secrets manager to store keys
- Rotate keys periodically by creating a new key, migrating your services, then revoking the old one
- Use separate keys for production and development