Authentication

All requests to the Wirebox Core API (api.wirebox.sh) require an API key passed in the standard HTTP Authorization header:

Authorization: Bearer wb_live_your_api_key_here

Obtaining an API Key

API keys can be generated from the Wirebox Console:

Go to Settings & Keys in the navigation sidebar.
Click Create API Key.
Choose a descriptive name (e.g., Production Agent Worker).
Copy the secret key immediately. For security, plaintext keys are only displayed once upon generation.

Wirebox stores only a salted SHA-256 hash of your API key in the database.

Key Scopes & Hierarchy

Wirebox supports two levels of API key scoping:

Key Type	Prefix	Description
Organization Key	`wb_live_...`	Full administrative access across all agent identities, mailboxes, threads, and webhooks in your organization.
Agent-Scoped Key	`wb_live_...`	Restricted to a single designated agent (e.g., `@eva`). The key can only inspect and send emails for that specific agent.

Example: Testing Your Key

Run a quick GET /me check to verify your API key and retrieve your organization details:

cURL

curl -X GET https://api.wirebox.sh/api/v1/me \
  -H "Authorization: Bearer $WIREBOX_API_KEY"

Response (200 OK):

{
  "user_id": "usr_01J8ABC123",
  "organization_id": "org_01J8XYZ789",
  "organization_name": "Acme AI Corp",
  "role": "admin"
}

Security Best Practices

Never expose your API key in client-side code, public GitHub repositories, or browser environments. Always inject your keys using environment variables (WIREBOX_API_KEY) on your backend servers.

Rotation: If a key is accidentally leaked, revoke it immediately from the Console. Active keys are revoked in real time without downtime for other keys.
Least Privilege: When deploying standalone agents or subagents, use agent-scoped keys to limit blast radius.

Get Started

Core Concepts

Guides

Obtaining an API Key

Key Scopes & Hierarchy

Example: Testing Your Key

Security Best Practices

​Obtaining an API Key

​Key Scopes & Hierarchy

​Example: Testing Your Key

​Security Best Practices

Obtaining an API Key

Key Scopes & Hierarchy

Example: Testing Your Key

Security Best Practices