curl --request POST \
--url https://breadbox.example.com/api/v1/api-keys \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"actor_type": "user",
"actor_name": "<string>"
}
'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"prefix": "<string>",
"last_used_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"key": "<string>"
}Create API key
Returns the plaintext key once in key. Persist it immediately —
subsequent reads expose only the prefix. Requires full_access scope.
curl --request POST \
--url https://breadbox.example.com/api/v1/api-keys \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"actor_type": "user",
"actor_name": "<string>"
}
'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"prefix": "<string>",
"last_used_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"key": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
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
full_access, read_only 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.
user, agent, system Response
Created key (plaintext returned once).