curl --request POST \
--url https://breadbox.example.com/api/v1/agents/cleanup \
--header 'X-API-Key: <api-key>'{}Run the agent cleanup pass on demand
Synchronously runs the same prune pass the 3:15 AM cron does:
deletes completed agent_runs older than agent.run_retention_days
and prunes the matching *.ndjson transcripts under
agent.transcript_dir. Returns the counts. Safe to call
repeatedly — a no-op when nothing’s eligible. Requires full_access scope.
curl --request POST \
--url https://breadbox.example.com/api/v1/agents/cleanup \
--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
Cleanup counts.
The response is of type object.