Skip to main content
Partial update of an agent definition
curl --request PATCH \
  --url https://breadbox.example.com/api/v1/workflows/{slug} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{}'
{}

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.

Path Parameters

slug
string
required

slug, short_id, or UUID

Body

application/json

The body is of type object.

Response

200 - application/json

Updated definition.

The response is of type object.

Last modified on June 5, 2026