Skip to main content
POST
/
api
/
v1
/
agents
/
test
Run the agent diagnostic smoke test
curl --request POST \
  --url https://breadbox.example.com/api/v1/agents/test \
  --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

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.

Response

Diagnostic result.

The response is of type object.