Docs
Authentication

API Authentication

Every Public API request must include an API key in the Authorization header. Keys start with xb_live_ and are hashed at rest. The full key is shown only when you create it.

Create a key

  1. Open https://xbeast.io/developers while logged in.
  2. Use a paid XBeast plan (free accounts cannot create keys).
  3. Name the key (for example Production) and click Create key.
  4. Copy the secret. You will not see it again.
You can have up to 5 active keys. Revoke unused keys from the same page.

Request header

Authorization: Bearer xb_live_YOUR_KEY
Example
curl "https://xbeast.io/api/v1/credits" \
  -H "Authorization: Bearer xb_live_YOUR_KEY"

Rules

FieldTypeRequiredDescription
SchemeBearerYesOnly Bearer tokens are accepted. Cookie session auth is not used on /api/v1.
PrefixstringYesKeys must start with xb_live_.
PlanpaidYesFree plans receive 403 forbidden even with a valid-looking header.

Failed auth

Missing, malformed, revoked, or unknown keys return 401 with error.code: unauthorized. See Errors.