curl --request POST \
--url https://breadbox.example.com/api/v1/workflows \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{}'{}Creates a Claude Agent SDK definition. Body includes the usual
name, slug, prompt, model, max_turns, max_budget_usd,
tool_scope, allowed_tools, schedule_cron, and the iter-30
trigger_on_sync_complete flag (fire after every successful
sync, in addition to any cron schedule).
Optionally includes connectors: an array of custom MCP connector
NAMES to enable on this workflow (mounted alongside the built-in
breadbox MCP — e.g. a remote Gmail MCP). The connector definitions +
credentials live in the global connector library, managed from the
Workflows settings page; this field only references them by name.
Requires full_access scope.
curl --request POST \
--url https://breadbox.example.com/api/v1/workflows \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{}'{}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.
Body
The body is of type object.
Response
Created definition.
The response is of type object.