REST API
Most agents should use the MCP server. The same operations are plain HTTPS for scripts.
- Base URL:
https://api.bakedbrie.com - Auth:
Authorization: Bearer <token>, a personal API token minted in BakedBrie settings. The token is bound to one workspace;X-Workspace-Idis optional and must match it. - Writes accept
Idempotency-Key(reuse it only to retry the same call) and, where a revision applies,If-Match: "<revision>". - Responses are
{"data": ..., "request_id": ..., "receipt_id": ...}; refusals are{"error": {"code", "message", ...}}. See the refusal guide. - Machine-readable: openapi.json (OpenAPI 3.1).
An operation whose capability is off answers 409 CAPABILITY_OFF. A Read only token can call only GET operations and preview-move.
| Method | Path | Capability | MCP tool |
|---|---|---|---|
| GET | /api/v1/boards | always on | [list_boards](/docs/reference/tools/list_boards) |
| POST | /api/v1/boards | always on | [create_board](/docs/reference/tools/create_board), [setup_board](/docs/reference/tools/setup_board) |
| GET | /api/v1/boards/{id} | always on | [read_board](/docs/reference/tools/read_board) |
| POST | /api/v1/boards/{id}/agents | agents | [create_agent_draft](/docs/reference/tools/create_agent_draft) |
| GET | /api/v1/boards/{id}/cards | always on | [list_cards](/docs/reference/tools/list_cards) |
| POST | /api/v1/boards/{id}/cards | always on | [create_card](/docs/reference/tools/create_card), [manage_schedule](/docs/reference/tools/manage_schedule) |
| GET | /api/v1/cards/{id} | always on | [read_card](/docs/reference/tools/read_card) |
| POST | /api/v1/cards/{id}/commands/move | always on | [move_card](/docs/reference/tools/move_card) |
| POST | /api/v1/cards/{id}/commands/preview-move | always on | [preview_move](/docs/reference/tools/preview_move) |
| POST | /api/v1/cards/{id}/commands/reorder | always on | [reorder_card](/docs/reference/tools/reorder_card) |
| POST | /api/v1/cards/{id}/comments | always on | [add_comment](/docs/reference/tools/add_comment) |
| GET | /api/v1/v21/agents | agents | |
| GET | /api/v1/v21/agents/{id} | agents | [manage_agent](/docs/reference/tools/manage_agent) |
| POST | /api/v1/v21/agents/{id}/commands/bind-ai-account | agents | |
| POST | /api/v1/v21/agents/{id}/commands/pause | agents | [manage_agent](/docs/reference/tools/manage_agent) |
| POST | /api/v1/v21/agents/{id}/commands/publish | agents | [publish_agent](/docs/reference/tools/publish_agent) |
| POST | /api/v1/v21/agents/{id}/commands/resume | agents | |
| POST | /api/v1/v21/agents/{id}/commands/retire | agents | |
| PUT | /api/v1/v21/agents/{id}/model | agents | [set_agent_model](/docs/reference/tools/set_agent_model) |
| GET | /api/v1/v21/agents/{id}/payer | agents | |
| GET | /api/v1/v21/ai-accounts | ai_accounts | [list_ai_accounts](/docs/reference/tools/list_ai_accounts) |
| POST | /api/v1/v21/ai-accounts | ai_accounts | [connect_ai_account](/docs/reference/tools/connect_ai_account) |
| DELETE | /api/v1/v21/ai-accounts/{id} | ai_accounts | [remove_ai_account](/docs/reference/tools/remove_ai_account) |
| GET | /api/v1/v21/ai-accounts/{id} | ai_accounts | [check_ai_account](/docs/reference/tools/check_ai_account) |
| POST | /api/v1/v21/ai-accounts/{id}/commands/bind | ai_accounts | [bind_ai_account](/docs/reference/tools/bind_ai_account) |
| POST | /api/v1/v21/ai-accounts/{id}/commands/check | ai_accounts | |
| POST | /api/v1/v21/ai-accounts/{id}/commands/set-runner-trust | runner | |
| PUT | /api/v1/v21/ai-accounts/{id}/key | ai_accounts | [replace_ai_account_key](/docs/reference/tools/replace_ai_account_key) |
| POST | /api/v1/v21/ai-accounts/commands/unbind | ai_accounts | [unbind_ai_account](/docs/reference/tools/unbind_ai_account) |
| GET | /api/v1/v21/ai-models | agents | [list_ai_models](/docs/reference/tools/list_ai_models) |
| DELETE | /api/v1/v21/board-connections/{id} | connections | [manage_board_connection](/docs/reference/tools/manage_board_connection) |
| GET | /api/v1/v21/board-connections/{id} | connections | [manage_board_connection](/docs/reference/tools/manage_board_connection) |
| PATCH | /api/v1/v21/board-connections/{id} | connections | [manage_board_connection](/docs/reference/tools/manage_board_connection) |
| POST | /api/v1/v21/board-connections/{id}/commands/lower-limits | connections | [manage_board_connection](/docs/reference/tools/manage_board_connection) |
| GET | /api/v1/v21/board-connections/{id}/usage | connections | [manage_board_connection](/docs/reference/tools/manage_board_connection) |
| GET | /api/v1/v21/board-connections/{id}/webhook-rules | connections + connections_oauth + connection_webhooks | [manage_connection_webhook](/docs/reference/tools/manage_connection_webhook) |
| POST | /api/v1/v21/board-connections/{id}/webhook-rules | connections + connections_oauth + connection_webhooks | [manage_connection_webhook](/docs/reference/tools/manage_connection_webhook) |
| GET | /api/v1/v21/boards/{board_id}/automations/{kind}/{owner_id}/send-mode | control | |
| GET | /api/v1/v21/boards/{board_id}/automations/send-mode | control | [list_send_modes](/docs/reference/tools/list_send_modes) |
| GET | /api/v1/v21/boards/{board_id}/send-notices | control | |
| GET | /api/v1/v21/boards/{board_id}/send-receipts | control | [list_send_receipts](/docs/reference/tools/list_send_receipts) |
| GET | /api/v1/v21/boards/{board_id}/send-reply-grants/{connection_id} | control | |
| GET | /api/v1/v21/boards/{board_id}/send-reviews | control | |
| GET | /api/v1/v21/boards/{board_id}/trigger-sources | triggers | [list_trigger_sources](/docs/reference/tools/list_trigger_sources) |
| POST | /api/v1/v21/boards/{id}/agents | agents | [create_agent_draft](/docs/reference/tools/create_agent_draft) |
| GET | /api/v1/v21/boards/{id}/connection-steps | connections | [manage_connection_step](/docs/reference/tools/manage_connection_step) |
| POST | /api/v1/v21/boards/{id}/connection-steps | connections | [manage_connection_step](/docs/reference/tools/manage_connection_step) |
| GET | /api/v1/v21/boards/{id}/connections | connections | [manage_board_connection](/docs/reference/tools/manage_board_connection) |
| POST | /api/v1/v21/boards/{id}/connections | connections | [manage_board_connection](/docs/reference/tools/manage_board_connection) |
| GET | /api/v1/v21/boards/{id}/destination | destinations | |
| PUT | /api/v1/v21/boards/{id}/destination | destinations | [manage_destination](/docs/reference/tools/manage_destination) |
| POST | /api/v1/v21/boards/{id}/device-pairings | media | [pair_device](/docs/reference/tools/pair_device) |
| GET | /api/v1/v21/boards/{id}/guidelines | agents + api_workflow | [manage_board_guidelines](/docs/reference/tools/manage_board_guidelines) |
| PUT | /api/v1/v21/boards/{id}/guidelines | agents + api_workflow | [manage_board_guidelines](/docs/reference/tools/manage_board_guidelines) |
| GET | /api/v1/v21/boards/{id}/hooks | destinations + api_workflow | [manage_board_hooks](/docs/reference/tools/manage_board_hooks) |
| PUT | /api/v1/v21/boards/{id}/hooks | destinations + api_workflow | [manage_board_hooks](/docs/reference/tools/manage_board_hooks) |
| POST | /api/v1/v21/boards/{id}/hooks/commands/clear | destinations + api_workflow | [manage_board_hooks](/docs/reference/tools/manage_board_hooks) |
| POST | /api/v1/v21/boards/{id}/job-steps | external_jobs | [manage_job_step](/docs/reference/tools/manage_job_step) |
| GET | /api/v1/v21/boards/{id}/learning-events | control | |
| GET | /api/v1/v21/boards/{id}/projection | control | |
| POST | /api/v1/v21/boards/{id}/rules | triggers | [author_workflow_draft](/docs/reference/tools/author_workflow_draft) |
| POST | /api/v1/v21/boards/{id}/schedules | triggers | [manage_schedule](/docs/reference/tools/manage_schedule) |
| POST | /api/v1/v21/boards/{id}/setups | setup | [setup_board](/docs/reference/tools/setup_board) |
| GET | /api/v1/v21/boards/{id}/stages | control | |
| POST | /api/v1/v21/boards/{id}/stages | control | [manage_stages](/docs/reference/tools/manage_stages) |
| POST | /api/v1/v21/boards/{id}/stages/commands/reorder | control | [manage_stages](/docs/reference/tools/manage_stages) |
| GET | /api/v1/v21/boards/{id}/work-folder | reviews | |
| PUT | /api/v1/v21/boards/{id}/work-folder | reviews | [set_work_folder](/docs/reference/tools/set_work_folder) |
| GET | /api/v1/v21/cards/{id}/connection-requests | connections | [manage_connection_request](/docs/reference/tools/manage_connection_request) |
| POST | /api/v1/v21/cards/{id}/connection-requests | connections | [request_connection](/docs/reference/tools/request_connection) |
| POST | /api/v1/v21/cards/{id}/connection-requests/commands/preview | connections | [request_connection](/docs/reference/tools/request_connection) |
| GET | /api/v1/v21/cards/{id}/deliveries | destinations | |
| PUT | /api/v1/v21/cards/{id}/destination | destinations | [manage_destination](/docs/reference/tools/manage_destination) |
| GET | /api/v1/v21/cards/{id}/files | media | [list_card_files](/docs/reference/tools/list_card_files) |
| GET | /api/v1/v21/cards/{id}/files/{file_id}/link | media | |
| POST | /api/v1/v21/cards/{id}/files/link | media | [attach_link](/docs/reference/tools/attach_link) |
| POST | /api/v1/v21/cards/{id}/files/provider-file | media | [attach_provider_file](/docs/reference/tools/attach_provider_file) |
| POST | /api/v1/v21/cards/{id}/files/transient-upload | media | [attach_local_file](/docs/reference/tools/attach_local_file), [prepare_transient_upload](/docs/reference/tools/prepare_transient_upload) |
| GET | /api/v1/v21/cards/{id}/outputs/{output_id} | media | [get_output](/docs/reference/tools/get_output) |
| GET | /api/v1/v21/cards/{id}/result | control | |
| GET | /api/v1/v21/connection-presets | connections_oauth | |
| GET | /api/v1/v21/connection-requests | connections | [manage_connection_request](/docs/reference/tools/manage_connection_request) |
| GET | /api/v1/v21/connection-requests/{id} | connections | [manage_connection_request](/docs/reference/tools/manage_connection_request) |
| POST | /api/v1/v21/connection-requests/{id}/commands/cancel | connections | [manage_connection_request](/docs/reference/tools/manage_connection_request) |
| POST | /api/v1/v21/connection-requests/{id}/commands/check-again | connections | [manage_connection_request](/docs/reference/tools/manage_connection_request) |
| POST | /api/v1/v21/connection-requests/{id}/commands/continue | connections | [manage_connection_request](/docs/reference/tools/manage_connection_request) |
| POST | /api/v1/v21/connection-requests/{id}/commands/give-up | connections | [manage_connection_request](/docs/reference/tools/manage_connection_request) |
| GET | /api/v1/v21/connection-steps/{id} | connections | [manage_connection_step](/docs/reference/tools/manage_connection_step) |
| PATCH | /api/v1/v21/connection-steps/{id} | connections | [manage_connection_step](/docs/reference/tools/manage_connection_step) |
| POST | /api/v1/v21/connection-steps/{id}/commands/pause | connections | [manage_connection_step](/docs/reference/tools/manage_connection_step) |
| POST | /api/v1/v21/connection-steps/{id}/commands/resume | connections | [manage_connection_step](/docs/reference/tools/manage_connection_step) |
| GET | /api/v1/v21/connection-webhooks | connections + connections_oauth + connection_webhooks | [manage_connection_webhook](/docs/reference/tools/manage_connection_webhook) |
| GET | /api/v1/v21/connection-webhooks/{id} | connections + connections_oauth + connection_webhooks | [manage_connection_webhook](/docs/reference/tools/manage_connection_webhook) |
| POST | /api/v1/v21/connection-webhooks/{id}/commands/pause | connections + connections_oauth + connection_webhooks | [manage_connection_webhook](/docs/reference/tools/manage_connection_webhook) |
| POST | /api/v1/v21/connection-webhooks/{id}/commands/resume | connections + connections_oauth + connection_webhooks | [manage_connection_webhook](/docs/reference/tools/manage_connection_webhook) |
| GET | /api/v1/v21/connection-webhooks/{id}/events | connections + connections_oauth + connection_webhooks | [manage_connection_webhook](/docs/reference/tools/manage_connection_webhook) |
| GET | /api/v1/v21/connections | connections | [manage_connection](/docs/reference/tools/manage_connection) |
| POST | /api/v1/v21/connections | connections | [manage_connection](/docs/reference/tools/manage_connection) |
| DELETE | /api/v1/v21/connections/{id} | connections | [manage_connection](/docs/reference/tools/manage_connection) |
| GET | /api/v1/v21/connections/{id} | connections | [manage_connection](/docs/reference/tools/manage_connection) |
| PATCH | /api/v1/v21/connections/{id} | connections | [manage_connection](/docs/reference/tools/manage_connection) |
| POST | /api/v1/v21/connections/{id}/commands/check-key | connections | [manage_connection](/docs/reference/tools/manage_connection) |
| POST | /api/v1/v21/connections/{id}/commands/disable | connections | [manage_connection](/docs/reference/tools/manage_connection) |
| POST | /api/v1/v21/connections/{id}/commands/enable | connections | [manage_connection](/docs/reference/tools/manage_connection) |
| POST | /api/v1/v21/connections/{id}/commands/lower-ceiling | connections | [manage_connection](/docs/reference/tools/manage_connection) |
| POST | /api/v1/v21/connections/{id}/commands/preview | connections | [manage_connection](/docs/reference/tools/manage_connection) |
| POST | /api/v1/v21/connections/{id}/commands/replace-key | connections | [manage_connection](/docs/reference/tools/manage_connection) |
| GET | /api/v1/v21/connections/{id}/key-checks/{key_check_id} | connections | [manage_connection](/docs/reference/tools/manage_connection) |
| GET | /api/v1/v21/connections/{id}/oauth | connections + connections_oauth | |
| POST | /api/v1/v21/connections/{id}/oauth/prepare | connections + connections_oauth | |
| POST | /api/v1/v21/connections/{id}/webhook | connections + connections_oauth + connection_webhooks | [manage_connection_webhook](/docs/reference/tools/manage_connection_webhook) |
| POST | /api/v1/v21/connections/commands/preview | connections | [manage_connection](/docs/reference/tools/manage_connection) |
| GET | /api/v1/v21/deliveries/{id} | destinations | |
| POST | /api/v1/v21/deliveries/{id}/commands/redeliver | destinations | [redeliver](/docs/reference/tools/redeliver) |
| GET | /api/v1/v21/destinations | destinations | |
| POST | /api/v1/v21/destinations | destinations | [manage_destination](/docs/reference/tools/manage_destination) |
| GET | /api/v1/v21/destinations/{id} | destinations | [manage_destination](/docs/reference/tools/manage_destination) |
| PUT | /api/v1/v21/destinations/{id} | destinations | [manage_destination](/docs/reference/tools/manage_destination) |
| POST | /api/v1/v21/destinations/{id}/commands/complete-oauth | destinations | [manage_destination](/docs/reference/tools/manage_destination) |
| POST | /api/v1/v21/destinations/{id}/commands/disable | destinations | [manage_destination](/docs/reference/tools/manage_destination) |
| POST | /api/v1/v21/destinations/{id}/commands/preview | destinations + api_workflow | |
| POST | /api/v1/v21/destinations/{id}/commands/test | destinations | [manage_destination](/docs/reference/tools/manage_destination) |
| POST | /api/v1/v21/destinations/{id}/commands/test-call | destinations + api_workflow | |
| GET | /api/v1/v21/destinations/{id}/test-calls/{test_call_id} | destinations + api_workflow | |
| POST | /api/v1/v21/destinations/commands/preview | destinations + api_workflow | |
| POST | /api/v1/v21/device-pairings/redeem | media | [pair_device](/docs/reference/tools/pair_device) |
| POST | /api/v1/v21/devices/{id}/files | media | [pair_device](/docs/reference/tools/pair_device) |
| POST | /api/v1/v21/devices/{id}/heartbeat | media | |
| POST | /api/v1/v21/dispatch/commands/pause | dispatch | [pause_workspace_dispatch](/docs/reference/tools/pause_workspace_dispatch) |
| POST | /api/v1/v21/dispatch/commands/resume | dispatch | [resume_workspace_dispatch](/docs/reference/tools/resume_workspace_dispatch) |
| GET | /api/v1/v21/inbound-endpoints | inbound + api_workflow | [manage_inbound_endpoint](/docs/reference/tools/manage_inbound_endpoint) |
| POST | /api/v1/v21/inbound-endpoints | inbound + api_workflow | [manage_inbound_endpoint](/docs/reference/tools/manage_inbound_endpoint) |
| GET | /api/v1/v21/inbound-endpoints/{id} | inbound + api_workflow | [manage_inbound_endpoint](/docs/reference/tools/manage_inbound_endpoint) |
| PUT | /api/v1/v21/inbound-endpoints/{id} | inbound + api_workflow | [manage_inbound_endpoint](/docs/reference/tools/manage_inbound_endpoint) |
| POST | /api/v1/v21/inbound-endpoints/{id}/commands/disable | inbound + api_workflow | [manage_inbound_endpoint](/docs/reference/tools/manage_inbound_endpoint) |
| GET | /api/v1/v21/job-steps/{id} | external_jobs | [manage_job_step](/docs/reference/tools/manage_job_step) |
| POST | /api/v1/v21/job-steps/{id}/commands/pause | external_jobs | [manage_job_step](/docs/reference/tools/manage_job_step) |
| POST | /api/v1/v21/job-steps/{id}/commands/resume | external_jobs | [manage_job_step](/docs/reference/tools/manage_job_step) |
| GET | /api/v1/v21/member-mappings | inbound + api_workflow | [manage_member_mapping](/docs/reference/tools/manage_member_mapping) |
| POST | /api/v1/v21/member-mappings | inbound + api_workflow | [manage_member_mapping](/docs/reference/tools/manage_member_mapping) |
| POST | /api/v1/v21/member-mappings/{id}/commands/remove | inbound + api_workflow | [manage_member_mapping](/docs/reference/tools/manage_member_mapping) |
| GET | /api/v1/v21/questions | control | |
| GET | /api/v1/v21/results | destinations | [list_results](/docs/reference/tools/list_results) |
| GET | /api/v1/v21/reviews | reviews | [list_reviews](/docs/reference/tools/list_reviews) |
| GET | /api/v1/v21/reviews/{id} | reviews | [get_review](/docs/reference/tools/get_review) |
| POST | /api/v1/v21/reviews/{id}/commands/decide | reviews | [decide_review](/docs/reference/tools/decide_review) |
| POST | /api/v1/v21/rules/{id}/commands/pause | triggers | |
| POST | /api/v1/v21/rules/{id}/commands/publish | triggers | [publish_workflow](/docs/reference/tools/publish_workflow) |
| GET | /api/v1/v21/runner-devices | runner | |
| POST | /api/v1/v21/runner/claim | runner (runner key only) | |
| POST | /api/v1/v21/runner/heartbeat | runner (runner key only) | |
| POST | /api/v1/v21/runner/hello | runner (runner key only) | |
| POST | /api/v1/v21/runner/runs/{id}/complete | runner (runner key only) | |
| POST | /api/v1/v21/runner/runs/{id}/fail | runner (runner key only) | |
| POST | /api/v1/v21/runner/runs/{id}/start | runner (runner key only) | |
| POST | /api/v1/v21/runner/runs/{id}/uploads | runner (runner key only) | |
| POST | /api/v1/v21/schedule-runs/{id}/cards | triggers | |
| POST | /api/v1/v21/schedules/{id}/commands/pause | triggers | |
| POST | /api/v1/v21/schedules/{id}/commands/publish | triggers | |
| POST | /api/v1/v21/schedules/{id}/commands/resume | triggers | |
| POST | /api/v1/v21/schedules/{id}/commands/run-now | triggers | [manage_schedule](/docs/reference/tools/manage_schedule) |
| GET | /api/v1/v21/schedules/{id}/history | triggers | |
| GET | /api/v1/v21/schedules/{id}/preview | triggers | |
| POST | /api/v1/v21/secret-drops | secrets | [prepare_secret](/docs/reference/tools/prepare_secret) |
| PUT | /api/v1/v21/secret-drops/{id} | secrets | [prepare_secret](/docs/reference/tools/prepare_secret) |
| POST | /api/v1/v21/setups/{id}/commands/undo | setup | [undo_setup](/docs/reference/tools/undo_setup) |
| GET | /api/v1/v21/slack-app/installs | slack_app + inbound + api_workflow | |
| DELETE | /api/v1/v21/stages/{id} | control | [manage_stages](/docs/reference/tools/manage_stages) |
| PUT | /api/v1/v21/stages/{id} | control | [manage_stages](/docs/reference/tools/manage_stages) |
| GET | /api/v1/v21/trigger-sources/{id} | triggers | [get_trigger_source](/docs/reference/tools/get_trigger_source) |
| GET | /api/v1/v21/triggers | triggers | [list_triggers](/docs/reference/tools/list_triggers) |
| PUT | /api/v1/v21/uploads/{id} | media | [attach_local_file](/docs/reference/tools/attach_local_file), [prepare_transient_upload](/docs/reference/tools/prepare_transient_upload) |
| GET | /api/v1/v21/webhook-rules/{id} | connections + connections_oauth + connection_webhooks | [manage_connection_webhook](/docs/reference/tools/manage_connection_webhook) |
| PATCH | /api/v1/v21/webhook-rules/{id} | connections + connections_oauth + connection_webhooks | [manage_connection_webhook](/docs/reference/tools/manage_connection_webhook) |
| POST | /api/v1/v21/webhook-rules/{id}/commands/pause | connections + connections_oauth + connection_webhooks | [manage_connection_webhook](/docs/reference/tools/manage_connection_webhook) |
| POST | /api/v1/v21/webhook-rules/{id}/commands/resume | connections + connections_oauth + connection_webhooks | [manage_connection_webhook](/docs/reference/tools/manage_connection_webhook) |
| GET | /api/v1/v21/whoami | control | [whoami](/docs/reference/tools/whoami) |
| POST | /api/v1/v21/workspace/commands/rename | control | [rename_workspace](/docs/reference/tools/rename_workspace) |
| GET | /api/v1/v21/workspace/sender-profiles | control | |
| GET | /api/v1/v21/workspace/suppressions | control |