Skip to main content
Create a key from Settings > Developer when API key management is available to your account. The full key is displayed once after creation or regeneration. Store it on your server in a secret manager or protected environment variable.

​
Request Headers

Use one of these headers with requests to your deployment’s /api/v1 endpoints:
Alternatively:
These are placeholders, not usable credentials. If both headers are sent, a Bearer authorization header takes precedence. Account login sessions and API keys are separate credentials; API key management uses your signed-in dashboard session.

​
Permissions and Restrictions

Each key has scopes that permit specific operations. An endpoint can reject a valid key if it lacks the required scope or its IP whitelist excludes the caller. Inactive, deleted, regenerated, or expired keys cannot authenticate with the old secret. The response includes X-Request-ID, and structured errors include meta.requestId. Keep this ID when reporting an error. Other endpoint-specific validation or access errors can also occur after authentication. See API Security for key handling and request limits.