Scopes
Give each integration only the scopes it uses. Call the API from your backend or test runner, and never put a key in a URL, client-side bundle, or log.
Authentication errors
Neither response consumes request allowance.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Authenticate requests and choose the scopes your integration needs.
Authorization: Bearer YOUR_API_KEY
| Scope | Allows |
|---|---|
domains:read | List available domains. |
emails:write | Create inboxes. |
emails:read | Read inboxes and list their messages. |
messages:read | Read messages, source, and attachments. |
usage:read | Read account usage. |
| Status | Meaning |
|---|---|
401 | The key is missing, malformed, revoked, or invalid. |
403 | The key is valid but lacks the required scope or account access. |