/api/v1/* must include an Authorization header with a Bearer token.
API key format
The suffix is 32 base62 characters. Keys are stored as a salted SHA-256 hash — if you lose a key, generate a new one. The original value cannot be recovered.
Getting a key
- Sign in to the dashboard.
- Go to API Keys.
- Click New API Key, choose a name, select the scopes you need, and copy the key immediately.
Scopes
Each key is issued with one or more scopes. Requests that require a scope the key doesn’t have return403 permission.
Rate limiting
Requests are rate-limited per API key. The current limit is returned in theX-RateLimit-Limit response header. Exceeding the limit returns 429 rate_limited.
Error responses
An invalid or missing key returns401 authentication: