Set or clear the operator note on a run
curl --request PATCH \
--url https://breadbox.example.com/api/v1/agents/runs/{shortId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"note": "<string>"
}
'{}Agents
Set or clear the operator note on a run
Body: { "note": "..." }. Empty string clears the field. Capped
at 2000 chars. Requires full_access scope.
PATCH
/
api
/
v1
/
agents
/
runs
/
{shortId}
Set or clear the operator note on a run
curl --request PATCH \
--url https://breadbox.example.com/api/v1/agents/runs/{shortId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"note": "<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
application/json
Maximum string length:
2000Response
200 - application/json
Updated run.
The response is of type object.
⌘I