Readiness probe for the agent subsystem
curl --request GET \
--url https://breadbox.example.com/api/v1/agents/status \
--header 'X-API-Key: <api-key>'{}Agents
Readiness probe for the agent subsystem
Side-effect-free check that returns whether the agent subsystem is ready to fire a run — auth configured + sidecar binary discoverable. Used by the v2 SPA list page to surface onboarding hints inline. Does NOT call Anthropic; for a live round-trip use POST /agents/test instead.
GET
/
api
/
v1
/
agents
/
status
Readiness probe for the agent subsystem
curl --request GET \
--url https://breadbox.example.com/api/v1/agents/status \
--header 'X-API-Key: <api-key>'{}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
200 - application/json
Readiness report.
The response is of type object.
⌘I