API Documentation

Authentication

Import the machine-readable specification into Postman, Insomnia, or another API client: OpenAPI 3.1

All authenticated API requests must include your API key in the Authorization header as a Bearer token:

Authorization: Bearer ib_live_<your-api-key>

API keys start with ib_live_ and are issued from your Dashboard after signing in. The complete key is shown only once; copy it immediately and store it in a secret manager. InboxBurn stores a one-way hash and cannot reveal the key later. A valid API key bypasses anonymous IP limits and only counts toward your monthly plan quota.

Inbox access token

Creating an inbox returns a separate secret token. Send it as X-Inbox-Token whenever you read, extend, delete, forward, or download data from that inbox. An API key identifies your account and quota; it does not replace the inbox token. Inbox tokens are shown only once and stored as a one-way hash.

If an API key may have leaked, revoke it from the Dashboard and create a replacement. Account settings also list signed-in browser sessions; you can revoke one session or sign out all sessions.

How to get an API key

  1. Sign in with the credentials sent to you after subscribing: inboxburn.com/signin
  2. Open the Dashboard.
  3. Click + New Key, optionally name it, and copy the ib_live_... string.

Example request

curl https://api.inboxburn.com/api/generate \ -H "Authorization: Bearer ib_live_<your-api-key>"

Anonymous access

You can generate an inbox without an API key, subject to anonymous per-IP limits. Reading, extending, deleting, forwarding, and downloading inbox data always requires the private inbox token. Paid capabilities such as forwarding also require an eligible API key.

Error codes

401Missing or invalid token
403Token valid but lacks permission
429Rate limit exceeded