Identify the calling API key (whoami)
curl --request GET \
--url https://breadbox.example.com/api/v1/keys/me \
--header 'X-API-Key: <api-key>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"key_prefix": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"actor_name": "<string>"
}API Keys
Identify the calling API key (whoami)
Returns the API key record corresponding to the presented
credential — name, prefix, scope, actor type/name. The full
secret is never re-exposed. Used by breadbox auth whoami so
agents and humans can confirm which identity the CLI is acting
under. Any scope; the data only describes the caller’s own key.
GET
/
api
/
v1
/
keys
/
me
Identify the calling API key (whoami)
curl --request GET \
--url https://breadbox.example.com/api/v1/keys/me \
--header 'X-API-Key: <api-key>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"key_prefix": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"actor_name": "<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.
Response
Identity record for the calling key.
⌘I