Authentication

Requests to the API are authenticated with an API key.

Creating an API key

API keys are managed from your account settings. To create one:

  1. Go to the Settings page.
  2. In the API Keys section, click Add API Key.
  3. Give the key a descriptive name (for example, My API Key) and click Save changes.
  4. Copy the generated key and store it somewhere safe.

The full key is only shown once, immediately after it is created. If you lose it, delete the key and create a new one.

Authenticating requests

Pass your API key in the Authorization header of every request. The key is sent as the raw header value (there is no Bearer prefix).

Request header
Authorization: <your-api-key>

Errors

Requests made without a valid API key are rejected. You may encounter the following responses:

StatusDescription
401 UnauthorizedThe Authorization header is missing or the key is invalid.
429 Too Many RequestsThe key has exceeded its rate limit. Wait before retrying.

Revoking a key

To revoke a key, return to the API Keys section in Settings and delete it. Revoked keys stop working immediately and cannot be restored.