curl --request POST \
--url https://breadbox.example.com/api/v1/agents/{slug}/run \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"prompt_prefix": "<string>",
"prompt": "<string>"
}
'{}Trigger an immediate agent run
Synchronously runs the named agent. Returns the resulting agent_runs
row. Status may be success, error, or timeout. Optional body
accepts prompt_prefix (prepends operator context to the saved
prompt for this fire only) and prompt (replaces the saved prompt
entirely for this fire — powers the iter-45 “Test this prompt”
button on the edit page). When both are set, prompt wins.
Requires full_access scope.
curl --request POST \
--url https://breadbox.example.com/api/v1/agents/{slug}/run \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"prompt_prefix": "<string>",
"prompt": "<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.
Path Parameters
Body
Response
Run completed (may be in error state — see status and error_message).
The response is of type object.