Authentication

Access to your subscriptions allowance.

API Key

Once you purchase a subscription you'll be able to view your API Key inside of the settings page of the dashboard.

API keys have the prefix of key_.
Do not share your API Key with anyone! This gives access to your subscriptions limits.

Authentication Errors

Status CodeExample Response
401{ "status": "ERROR", "error": "Missing or invalid X-API-KEY header." }
401{ "status": "ERROR", "error": "X-API-KEY is invalid." }
401{ "status": "ERROR", "error": "The provided key is not active." }
401{ "status": "ERROR", "error": "Issue with APIKey, admin has been notified." }
403{ "status": "ERROR", "error": "You have reached the limit of your API allowance." }