Skip to main content
Create API key

Authorizations

X-API-Key
string
header
required

Breadbox API key with format bb_<base62>. Carries either read_only or full_access scope. Write endpoints (and a handful of sensitive reads — /api-keys, /users/{user_id}/login) require full_access; endpoints that require it are flagged in their description.

Body

application/json
name
string
required
scope
enum<string>
required
Available options:
full_access,
read_only
actor_type
enum<string>
default:user

Attribution category. Defaults to user for human-driven integrations. agent keys are short-lived runtime credentials minted by the agent orchestrator and are auto-revoked after 1 hour by the startup cleanup sweep — do not request agent for long-lived integrations.

Available options:
user,
agent,
system
actor_name
string | null

Response

201 - application/json

Created key (plaintext returned once).

id
string
short_id
string
name
string
prefix
string
scope
enum<string>
Available options:
full_access,
read_only
last_used_at
string<date-time> | null
revoked_at
string<date-time> | null
created_at
string<date-time>
key
string

Plaintext key. Shown once on creation.

Last modified on June 25, 2026