{ "openapi": "3.1.0", "info": { "title": "BakedBrie token API", "version": "1.0.0", "description": "Every REST operation a workspace-bound personal API token can call. Board and card operations are always available; V2.1 operations are available only while their capability is on (see x-capability) and otherwise answer 409 CAPABILITY_OFF. Runner operations (x-token-preset: runner) accept only a runner key." }, "servers": [ { "url": "https://api.bakedbrie.com" } ], "paths": { "/api/v1/boards": { "get": { "operationId": "listBoards", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": "50", "type": "string", "pattern": "^(?:[1-9][0-9]?|100)$" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "pattern": "^[A-Za-z0-9_-]+$" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } } ], "security": [ { "scopedBearer": [] } ], "x-protocol": { "request": "json", "response": "json", "authority": "scoped-bearer" }, "responses": { "200": { "description": "Durable result or resource", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "workspace_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "owner_user_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "fallback_owner_user_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "privacy": { "type": "string", "enum": [ "private", "workspace" ] }, "workflow_version_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "revision": { "type": "string", "maxLength": 19, "pattern": "^(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)$" }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "allowed": { "type": "boolean" }, "stages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "label": { "type": "string" }, "position": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$" }, "role": { "type": "string", "enum": [ "entry", "middle", "done" ] } }, "required": [ "id", "label", "position" ], "additionalProperties": false } } }, "required": [ "id", "workspace_id", "name", "description", "owner_user_id", "fallback_owner_user_id", "privacy", "workflow_version_id", "revision", "archived_at", "created_at", "updated_at" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "receipt_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "request_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, "required": [ "data", "receipt_id", "request_id" ], "additionalProperties": false } } } }, "400": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "428": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } }, "Retry-After": { "required": true, "schema": { "type": "string", "pattern": "^[1-9][0-9]*$" }, "description": "Minimum seconds before a new attempt; capacity or current authority may still block it. No automatic mutation retry." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "default": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "description": "Workspace-bound token access. Current membership and board access are checked on each request." }, "post": { "operationId": "createBoard", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[!-~]+$" } } ], "security": [ { "scopedBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "default": "", "type": "string", "maxLength": 4000 } }, "required": [ "name" ], "additionalProperties": false } } } }, "x-protocol": { "request": "json", "response": "json", "authority": "scoped-bearer" }, "responses": { "201": { "description": "Durable result or resource", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "board_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "workspace_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "revision": { "type": "string", "maxLength": 19, "pattern": "^(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)$" } }, "required": [ "id", "board_id", "workspace_id", "revision" ], "additionalProperties": false }, "receipt_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "request_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, "required": [ "data", "receipt_id", "request_id" ], "additionalProperties": false } } } }, "400": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "428": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } }, "Retry-After": { "required": true, "schema": { "type": "string", "pattern": "^[1-9][0-9]*$" }, "description": "Minimum seconds before a new attempt; capacity or current authority may still block it. No automatic mutation retry." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "default": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "description": "Workspace-bound token access. Current membership and board access are checked on each request." } }, "/api/v1/boards/{id}": { "get": { "operationId": "readBoard", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } } ], "security": [ { "scopedBearer": [] } ], "x-protocol": { "request": "json", "response": "json", "authority": "scoped-bearer" }, "responses": { "200": { "description": "Durable result or resource", "headers": { "ETag": { "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "maxLength": 21, "pattern": "^\"(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)\"$" } }, "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "workspace_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "owner_user_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "fallback_owner_user_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "privacy": { "type": "string", "enum": [ "private", "workspace" ] }, "workflow_version_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "revision": { "type": "string", "maxLength": 19, "pattern": "^(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)$" }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "allowed": { "type": "boolean" }, "stages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "label": { "type": "string" }, "position": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$" }, "role": { "type": "string", "enum": [ "entry", "middle", "done" ] } }, "required": [ "id", "label", "position" ], "additionalProperties": false } } }, "required": [ "id", "workspace_id", "name", "description", "owner_user_id", "fallback_owner_user_id", "privacy", "workflow_version_id", "revision", "archived_at", "created_at", "updated_at" ], "additionalProperties": false }, "receipt_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "request_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, "required": [ "data", "receipt_id", "request_id" ], "additionalProperties": false } } } }, "400": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "428": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } }, "Retry-After": { "required": true, "schema": { "type": "string", "pattern": "^[1-9][0-9]*$" }, "description": "Minimum seconds before a new attempt; capacity or current authority may still block it. No automatic mutation retry." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "default": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "description": "Workspace-bound token access. Current membership and board access are checked on each request." } }, "/api/v1/boards/{id}/agents": { "post": { "operationId": "v21_post__api_v1_boards_by_id_agents", "summary": "POST /api/v1/boards/{id}/agents", "description": "Available while the `agents` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `create_agent_draft`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "agents", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/boards/{id}/cards": { "get": { "operationId": "listCards", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": "50", "type": "string", "pattern": "^(?:[1-9][0-9]?|100)$" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 2048, "pattern": "^[A-Za-z0-9_-]+$" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ready", "queued", "working", "needs_input", "waiting", "blocked", "paused", "done", "cancelled" ] } }, { "name": "stage_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "owner_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 500 } }, { "name": "label_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } } ] } }, { "name": "archived", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "include_archived", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } } ], "security": [ { "scopedBearer": [] } ], "x-protocol": { "request": "json", "response": "json", "authority": "scoped-bearer" }, "responses": { "200": { "description": "Durable result or resource", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "card_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "workspace_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "board_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "title": { "type": "string" }, "stage_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "ready", "queued", "working", "needs_input", "waiting", "blocked", "paused", "done", "cancelled" ] }, "owner": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "human", "agent", "automation" ] }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "label": { "type": "string" } }, "required": [ "kind", "id" ], "additionalProperties": false }, "revision": { "type": "string", "maxLength": 19, "pattern": "^(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)$" }, "iteration_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "active_input_revision_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "pending_input_revision_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "due_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "manual_move_allowed": { "type": "boolean" }, "manual_reorder_allowed": { "type": "boolean" }, "manual_move_block": { "anyOf": [ { "type": "string", "maxLength": 80, "pattern": "^[A-Z][A-Z0-9_]*$" }, { "type": "null" } ] }, "labels": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "name": { "type": "string" }, "color": { "type": "string", "enum": [ "slate", "red", "orange", "amber", "green", "teal", "blue", "indigo", "violet", "pink" ] } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "checklist_progress": { "anyOf": [ { "type": "object", "properties": { "checked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "checked", "total" ], "additionalProperties": false }, { "type": "null" } ] }, "comment_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "card_id", "workspace_id", "board_id", "title", "stage_id", "status", "owner", "revision", "iteration_id", "active_input_revision_id", "pending_input_revision_id", "archived_at", "due_at", "manual_move_allowed", "manual_reorder_allowed", "manual_move_block" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "receipt_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "request_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, "required": [ "data", "receipt_id", "request_id" ], "additionalProperties": false } } } }, "400": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "428": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } }, "Retry-After": { "required": true, "schema": { "type": "string", "pattern": "^[1-9][0-9]*$" }, "description": "Minimum seconds before a new attempt; capacity or current authority may still block it. No automatic mutation retry." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "default": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "description": "Workspace-bound token access. Current membership and board access are checked on each request." }, "post": { "operationId": "createCard", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "maxLength": 21, "pattern": "^\"(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[!-~]+$" } } ], "security": [ { "scopedBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "brief": { "default": "", "type": "string", "maxLength": 100000 }, "fields": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "owner": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "human", "agent", "automation" ] }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "label": { "type": "string" } }, "required": [ "kind", "id" ], "additionalProperties": false }, "artifact_ids": { "default": [], "maxItems": 100, "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, "due_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "title" ], "additionalProperties": false } } } }, "x-protocol": { "request": "json", "response": "json", "authority": "scoped-bearer" }, "responses": { "201": { "description": "Durable result or resource", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "card_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "workspace_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "board_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "title": { "type": "string" }, "stage_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "ready", "queued", "working", "needs_input", "waiting", "blocked", "paused", "done", "cancelled" ] }, "owner": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "human", "agent", "automation" ] }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "label": { "type": "string" } }, "required": [ "kind", "id" ], "additionalProperties": false }, "revision": { "type": "string", "maxLength": 19, "pattern": "^(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)$" }, "iteration_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "active_input_revision_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "pending_input_revision_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "due_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "card_id", "workspace_id", "board_id", "title", "stage_id", "status", "owner", "revision", "iteration_id", "active_input_revision_id", "pending_input_revision_id", "archived_at", "due_at" ], "additionalProperties": false }, "receipt_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "request_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, "required": [ "data", "receipt_id", "request_id" ], "additionalProperties": false } } } }, "400": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "428": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } }, "Retry-After": { "required": true, "schema": { "type": "string", "pattern": "^[1-9][0-9]*$" }, "description": "Minimum seconds before a new attempt; capacity or current authority may still block it. No automatic mutation retry." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "default": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "description": "Workspace-bound token access. Current membership and board access are checked on each request." } }, "/api/v1/cards/{id}": { "get": { "operationId": "readCard", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } } ], "security": [ { "scopedBearer": [] } ], "x-protocol": { "request": "json", "response": "json", "authority": "scoped-bearer" }, "responses": { "200": { "description": "Durable result or resource", "headers": { "ETag": { "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "maxLength": 21, "pattern": "^\"(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)\"$" } }, "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "card_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "workspace_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "board_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "title": { "type": "string" }, "stage_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "ready", "queued", "working", "needs_input", "waiting", "blocked", "paused", "done", "cancelled" ] }, "owner": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "human", "agent", "automation" ] }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "label": { "type": "string" } }, "required": [ "kind", "id" ], "additionalProperties": false }, "revision": { "type": "string", "maxLength": 19, "pattern": "^(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)$" }, "iteration_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "active_input_revision_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "pending_input_revision_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "due_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "input_revision": { "type": "object", "properties": { "workspace_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "card_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "brief": { "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "content_hash": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" }, "created_by": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "workspace_id", "id", "card_id", "sequence", "brief", "fields", "content_hash", "created_by", "created_at", "updated_at" ], "additionalProperties": false }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "body": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "author_label": { "type": "string" } }, "required": [ "id", "body", "created_at", "author_label" ], "additionalProperties": false } }, "labels": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "name": { "type": "string" }, "color": { "type": "string", "enum": [ "slate", "red", "orange", "amber", "green", "teal", "blue", "indigo", "violet", "pink" ] } }, "required": [ "id", "name", "color" ], "additionalProperties": false } }, "checklists": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "card_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "title": { "type": "string" }, "revision": { "type": "string", "maxLength": 19, "pattern": "^(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)$" }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "checklist_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "text": { "type": "string" }, "checked_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "converted_card_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "revision": { "type": "string", "maxLength": 19, "pattern": "^(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)$" }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "checklist_id", "text", "checked_at", "converted_card_id", "revision", "created_at", "updated_at" ], "additionalProperties": false } } }, "required": [ "id", "card_id", "title", "revision", "created_at", "updated_at", "items" ], "additionalProperties": false } }, "comments_page": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "card_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "body": { "type": "string", "maxLength": 20000 }, "author_label": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "edited_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "removed_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "revision": { "type": "string", "maxLength": 19, "pattern": "^(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)$" } }, "required": [ "id", "card_id", "body", "author_label", "created_at", "updated_at", "edited_at", "removed_at", "revision" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "comment_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "activity": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "action": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "id", "action", "created_at", "data" ], "additionalProperties": false } }, "available_commands": { "type": "array", "items": { "type": "string" } }, "completion_receipts": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "iteration_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "completed", "done" ] }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "iteration_id", "state", "created_at" ], "additionalProperties": false } }, "waiting_reason": { "anyOf": [ { "type": "string", "enum": [ "ai_account_required", "runner_offline", "runner_provider_off", "runner_untrusted_card" ] }, { "type": "null" } ] }, "latest_run": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "state": { "type": "string", "maxLength": 40 }, "agent_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "agent_name": { "type": [ "string", "null" ] }, "round": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "error_code": { "anyOf": [ { "type": "string", "maxLength": 80 }, { "type": "null" } ] }, "error_message_key": { "anyOf": [ { "type": "string", "maxLength": 80 }, { "type": "null" } ] }, "updated_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "state", "agent_id", "agent_name", "round", "error_code", "error_message_key", "updated_at" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "card_id", "workspace_id", "board_id", "title", "stage_id", "status", "owner", "revision", "iteration_id", "active_input_revision_id", "pending_input_revision_id", "archived_at", "due_at", "input_revision", "comments", "activity", "available_commands", "completion_receipts", "waiting_reason", "latest_run" ], "additionalProperties": false }, "receipt_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "request_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, "required": [ "data", "receipt_id", "request_id" ], "additionalProperties": false } } } }, "400": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "428": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } }, "Retry-After": { "required": true, "schema": { "type": "string", "pattern": "^[1-9][0-9]*$" }, "description": "Minimum seconds before a new attempt; capacity or current authority may still block it. No automatic mutation retry." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "default": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "description": "Workspace-bound token access. Current membership and board access are checked on each request." } }, "/api/v1/cards/{id}/commands/move": { "post": { "operationId": "moveCard", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "maxLength": 21, "pattern": "^\"(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[!-~]+$" } } ], "security": [ { "scopedBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "destination_stage_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "preview_hash": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" }, "before_card_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "after_card_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "edge": { "type": "string", "enum": [ "top", "bottom" ] } }, "required": [ "destination_stage_id", "preview_hash" ], "additionalProperties": false } } } }, "x-protocol": { "request": "json", "response": "json", "authority": "scoped-bearer" }, "responses": { "200": { "description": "Durable result or resource", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "card_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "workspace_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "board_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "title": { "type": "string" }, "stage_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "ready", "queued", "working", "needs_input", "waiting", "blocked", "paused", "done", "cancelled" ] }, "owner": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "human", "agent", "automation" ] }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "label": { "type": "string" } }, "required": [ "kind", "id" ], "additionalProperties": false }, "revision": { "type": "string", "maxLength": 19, "pattern": "^(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)$" }, "iteration_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "active_input_revision_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "pending_input_revision_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "due_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "card_id", "workspace_id", "board_id", "title", "stage_id", "status", "owner", "revision", "iteration_id", "active_input_revision_id", "pending_input_revision_id", "archived_at", "due_at" ], "additionalProperties": false }, "receipt_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "request_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, "required": [ "data", "receipt_id", "request_id" ], "additionalProperties": false } } } }, "400": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "428": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } }, "Retry-After": { "required": true, "schema": { "type": "string", "pattern": "^[1-9][0-9]*$" }, "description": "Minimum seconds before a new attempt; capacity or current authority may still block it. No automatic mutation retry." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "default": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "description": "Workspace-bound token access. Current membership and board access are checked on each request." } }, "/api/v1/cards/{id}/commands/preview-move": { "post": { "operationId": "previewMove", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "maxLength": 21, "pattern": "^\"(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)\"$" } } ], "security": [ { "scopedBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "destination_stage_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, "required": [ "destination_stage_id" ], "additionalProperties": false } } } }, "x-protocol": { "request": "json", "response": "json", "authority": "scoped-bearer" }, "responses": { "200": { "description": "Durable result or resource", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "object", "properties": { "preview_hash": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" }, "destination_stage_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "entry_step_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "owner": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "human", "agent", "automation" ] }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "label": { "type": "string" } }, "required": [ "kind", "id" ], "additionalProperties": false }, "consequences": { "type": "array", "items": { "type": "string" } }, "missing": { "type": "array", "items": { "type": "string" } } }, "required": [ "preview_hash", "destination_stage_id", "entry_step_id", "owner", "consequences", "missing" ], "additionalProperties": false }, "receipt_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "request_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, "required": [ "data", "receipt_id", "request_id" ], "additionalProperties": false } } } }, "400": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "428": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } }, "Retry-After": { "required": true, "schema": { "type": "string", "pattern": "^[1-9][0-9]*$" }, "description": "Minimum seconds before a new attempt; capacity or current authority may still block it. No automatic mutation retry." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "default": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "description": "Workspace-bound token access. Current membership and board access are checked on each request." } }, "/api/v1/cards/{id}/commands/reorder": { "post": { "operationId": "reorderCard", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "maxLength": 21, "pattern": "^\"(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[!-~]+$" } } ], "security": [ { "scopedBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "before_card_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "after_card_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "edge": { "type": "string", "enum": [ "top", "bottom" ] } }, "additionalProperties": false } } } }, "x-protocol": { "request": "json", "response": "json", "authority": "scoped-bearer" }, "responses": { "200": { "description": "Durable result or resource", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "card_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "workspace_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "board_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "title": { "type": "string" }, "stage_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "ready", "queued", "working", "needs_input", "waiting", "blocked", "paused", "done", "cancelled" ] }, "owner": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "human", "agent", "automation" ] }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "label": { "type": "string" } }, "required": [ "kind", "id" ], "additionalProperties": false }, "revision": { "type": "string", "maxLength": 19, "pattern": "^(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)$" }, "iteration_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "active_input_revision_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "pending_input_revision_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "due_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "card_id", "workspace_id", "board_id", "title", "stage_id", "status", "owner", "revision", "iteration_id", "active_input_revision_id", "pending_input_revision_id", "archived_at", "due_at" ], "additionalProperties": false }, "receipt_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "request_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, "required": [ "data", "receipt_id", "request_id" ], "additionalProperties": false } } } }, "400": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "428": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } }, "Retry-After": { "required": true, "schema": { "type": "string", "pattern": "^[1-9][0-9]*$" }, "description": "Minimum seconds before a new attempt; capacity or current authority may still block it. No automatic mutation retry." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "default": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "description": "Workspace-bound token access. Current membership and board access are checked on each request." } }, "/api/v1/cards/{id}/comments": { "post": { "operationId": "addComment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "maxLength": 21, "pattern": "^\"(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[!-~]+$" } } ], "security": [ { "scopedBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 20000 } }, "required": [ "body" ], "additionalProperties": false } } } }, "x-protocol": { "request": "json", "response": "json", "authority": "scoped-bearer" }, "responses": { "201": { "description": "Durable result or resource", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "body": { "type": "string" } }, "required": [ "id", "body" ], "additionalProperties": false }, "receipt_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "request_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" } }, "required": [ "data", "receipt_id", "request_id" ], "additionalProperties": false } } } }, "400": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "428": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } }, "Retry-After": { "required": true, "schema": { "type": "string", "pattern": "^[1-9][0-9]*$" }, "description": "Minimum seconds before a new attempt; capacity or current authority may still block it. No automatic mutation retry." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "default": { "description": "Explicit failure envelope", "headers": { "Cache-Control": { "schema": { "const": "no-store" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "description": "Workspace-bound token access. Current membership and board access are checked on each request." } }, "/api/v1/v21/agents": { "get": { "operationId": "v21_get_agents", "summary": "GET /api/v1/v21/agents", "description": "Available while the `agents` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "agents", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/agents/{id}": { "get": { "operationId": "v21_get_agents_by_id", "summary": "GET /api/v1/v21/agents/{id}", "description": "Available while the `agents` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_agent`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "agents", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/agents/{id}/commands/bind-ai-account": { "post": { "operationId": "v21_post_agents_by_id_commands_bind_ai_account", "summary": "POST /api/v1/v21/agents/{id}/commands/bind-ai-account", "description": "Available while the `agents` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "agents", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/agents/{id}/commands/pause": { "post": { "operationId": "v21_post_agents_by_id_commands_pause", "summary": "POST /api/v1/v21/agents/{id}/commands/pause", "description": "Available while the `agents` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_agent`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "agents", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/agents/{id}/commands/publish": { "post": { "operationId": "v21_post_agents_by_id_commands_publish", "summary": "POST /api/v1/v21/agents/{id}/commands/publish", "description": "Available while the `agents` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `publish_agent`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "agents", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/agents/{id}/commands/resume": { "post": { "operationId": "v21_post_agents_by_id_commands_resume", "summary": "POST /api/v1/v21/agents/{id}/commands/resume", "description": "Available while the `agents` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "agents", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/agents/{id}/commands/retire": { "post": { "operationId": "v21_post_agents_by_id_commands_retire", "summary": "POST /api/v1/v21/agents/{id}/commands/retire", "description": "Available while the `agents` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "agents", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/agents/{id}/model": { "put": { "operationId": "v21_put_agents_by_id_model", "summary": "PUT /api/v1/v21/agents/{id}/model", "description": "Available while the `agents` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `set_agent_model`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "agents", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/agents/{id}/payer": { "get": { "operationId": "v21_get_agents_by_id_payer", "summary": "GET /api/v1/v21/agents/{id}/payer", "description": "Available while the `agents` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "agents", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/ai-accounts": { "get": { "operationId": "v21_get_ai_accounts", "summary": "GET /api/v1/v21/ai-accounts", "description": "Available while the `ai_accounts` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `list_ai_accounts`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "ai_accounts", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "post": { "operationId": "v21_post_ai_accounts", "summary": "POST /api/v1/v21/ai-accounts", "description": "Available while the `ai_accounts` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `connect_ai_account`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "ai_accounts", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/ai-accounts/commands/unbind": { "post": { "operationId": "v21_post_ai_accounts_commands_unbind", "summary": "POST /api/v1/v21/ai-accounts/commands/unbind", "description": "Available while the `ai_accounts` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `unbind_ai_account`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "ai_accounts", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/ai-accounts/{id}": { "delete": { "operationId": "v21_delete_ai_accounts_by_id", "summary": "DELETE /api/v1/v21/ai-accounts/{id}", "description": "Available while the `ai_accounts` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `remove_ai_account`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "ai_accounts", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "get": { "operationId": "v21_get_ai_accounts_by_id", "summary": "GET /api/v1/v21/ai-accounts/{id}", "description": "Available while the `ai_accounts` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `check_ai_account`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "ai_accounts", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/ai-accounts/{id}/commands/bind": { "post": { "operationId": "v21_post_ai_accounts_by_id_commands_bind", "summary": "POST /api/v1/v21/ai-accounts/{id}/commands/bind", "description": "Available while the `ai_accounts` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `bind_ai_account`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "ai_accounts", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/ai-accounts/{id}/commands/check": { "post": { "operationId": "v21_post_ai_accounts_by_id_commands_check", "summary": "POST /api/v1/v21/ai-accounts/{id}/commands/check", "description": "Available while the `ai_accounts` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "ai_accounts", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/ai-accounts/{id}/commands/set-runner-trust": { "post": { "operationId": "v21_post_ai_accounts_by_id_commands_set_runner_trust", "summary": "POST /api/v1/v21/ai-accounts/{id}/commands/set-runner-trust", "description": "Available while the `runner` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "runner", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/ai-accounts/{id}/key": { "put": { "operationId": "v21_put_ai_accounts_by_id_key", "summary": "PUT /api/v1/v21/ai-accounts/{id}/key", "description": "Available while the `ai_accounts` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `replace_ai_account_key`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "ai_accounts", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/ai-models": { "get": { "operationId": "v21_get_ai_models", "summary": "GET /api/v1/v21/ai-models", "description": "Available while the `agents` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `list_ai_models`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "agents", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/board-connections/{id}": { "delete": { "operationId": "v21_delete_board_connections_by_id", "summary": "DELETE /api/v1/v21/board-connections/{id}", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_board_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "get": { "operationId": "v21_get_board_connections_by_id", "summary": "GET /api/v1/v21/board-connections/{id}", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_board_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "patch": { "operationId": "v21_patch_board_connections_by_id", "summary": "PATCH /api/v1/v21/board-connections/{id}", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_board_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/board-connections/{id}/commands/lower-limits": { "post": { "operationId": "v21_post_board_connections_by_id_commands_lower_limits", "summary": "POST /api/v1/v21/board-connections/{id}/commands/lower-limits", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_board_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/board-connections/{id}/usage": { "get": { "operationId": "v21_get_board_connections_by_id_usage", "summary": "GET /api/v1/v21/board-connections/{id}/usage", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_board_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/board-connections/{id}/webhook-rules": { "get": { "operationId": "v21_get_board_connections_by_id_webhook_rules", "summary": "GET /api/v1/v21/board-connections/{id}/webhook-rules", "description": "Available while the `connections` and `connections_oauth` and `connection_webhooks` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_webhook`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "x-requires": [ "connections_oauth", "connection_webhooks" ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "post": { "operationId": "v21_post_board_connections_by_id_webhook_rules", "summary": "POST /api/v1/v21/board-connections/{id}/webhook-rules", "description": "Available while the `connections` and `connections_oauth` and `connection_webhooks` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_webhook`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "x-requires": [ "connections_oauth", "connection_webhooks" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{board_id}/automations/send-mode": { "get": { "operationId": "v21_get_boards_by_board_id_automations_send_mode", "summary": "GET /api/v1/v21/boards/{board_id}/automations/send-mode", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `list_send_modes`.", "parameters": [ { "name": "board_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{board_id}/automations/{kind}/{owner_id}/send-mode": { "get": { "operationId": "v21_get_boards_by_board_id_automations_by_kind_by_owner_id_send_mode", "summary": "GET /api/v1/v21/boards/{board_id}/automations/{kind}/{owner_id}/send-mode", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "board_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "owner_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{board_id}/send-notices": { "get": { "operationId": "v21_get_boards_by_board_id_send_notices", "summary": "GET /api/v1/v21/boards/{board_id}/send-notices", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "board_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{board_id}/send-receipts": { "get": { "operationId": "v21_get_boards_by_board_id_send_receipts", "summary": "GET /api/v1/v21/boards/{board_id}/send-receipts", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `list_send_receipts`.", "parameters": [ { "name": "board_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{board_id}/send-reply-grants/{connection_id}": { "get": { "operationId": "v21_get_boards_by_board_id_send_reply_grants_by_connection_id", "summary": "GET /api/v1/v21/boards/{board_id}/send-reply-grants/{connection_id}", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "board_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{board_id}/send-reviews": { "get": { "operationId": "v21_get_boards_by_board_id_send_reviews", "summary": "GET /api/v1/v21/boards/{board_id}/send-reviews", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "board_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{board_id}/trigger-sources": { "get": { "operationId": "v21_get_boards_by_board_id_trigger_sources", "summary": "GET /api/v1/v21/boards/{board_id}/trigger-sources", "description": "Available while the `triggers` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `list_trigger_sources`.", "parameters": [ { "name": "board_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "triggers", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/agents": { "post": { "operationId": "v21_post_boards_by_id_agents", "summary": "POST /api/v1/v21/boards/{id}/agents", "description": "Available while the `agents` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `create_agent_draft`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "agents", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/connection-steps": { "get": { "operationId": "v21_get_boards_by_id_connection_steps", "summary": "GET /api/v1/v21/boards/{id}/connection-steps", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_step`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "post": { "operationId": "v21_post_boards_by_id_connection_steps", "summary": "POST /api/v1/v21/boards/{id}/connection-steps", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_step`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/connections": { "get": { "operationId": "v21_get_boards_by_id_connections", "summary": "GET /api/v1/v21/boards/{id}/connections", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_board_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "post": { "operationId": "v21_post_boards_by_id_connections", "summary": "POST /api/v1/v21/boards/{id}/connections", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_board_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/destination": { "get": { "operationId": "v21_get_boards_by_id_destination", "summary": "GET /api/v1/v21/boards/{id}/destination", "description": "Available while the `destinations` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "put": { "operationId": "v21_put_boards_by_id_destination", "summary": "PUT /api/v1/v21/boards/{id}/destination", "description": "Available while the `destinations` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_destination`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/device-pairings": { "post": { "operationId": "v21_post_boards_by_id_device_pairings", "summary": "POST /api/v1/v21/boards/{id}/device-pairings", "description": "Available while the `media` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `pair_device`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "media", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/guidelines": { "get": { "operationId": "v21_get_boards_by_id_guidelines", "summary": "GET /api/v1/v21/boards/{id}/guidelines", "description": "Available while the `agents` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_board_guidelines`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "agents", "x-requires": [ "api_workflow" ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "put": { "operationId": "v21_put_boards_by_id_guidelines", "summary": "PUT /api/v1/v21/boards/{id}/guidelines", "description": "Available while the `agents` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_board_guidelines`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "agents", "x-requires": [ "api_workflow" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/hooks": { "get": { "operationId": "v21_get_boards_by_id_hooks", "summary": "GET /api/v1/v21/boards/{id}/hooks", "description": "Available while the `destinations` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_board_hooks`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "x-requires": [ "api_workflow" ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "put": { "operationId": "v21_put_boards_by_id_hooks", "summary": "PUT /api/v1/v21/boards/{id}/hooks", "description": "Available while the `destinations` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_board_hooks`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "x-requires": [ "api_workflow" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/hooks/commands/clear": { "post": { "operationId": "v21_post_boards_by_id_hooks_commands_clear", "summary": "POST /api/v1/v21/boards/{id}/hooks/commands/clear", "description": "Available while the `destinations` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_board_hooks`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "x-requires": [ "api_workflow" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/job-steps": { "post": { "operationId": "v21_post_boards_by_id_job_steps", "summary": "POST /api/v1/v21/boards/{id}/job-steps", "description": "Available while the `external_jobs` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_job_step`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "external_jobs", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/learning-events": { "get": { "operationId": "v21_get_boards_by_id_learning_events", "summary": "GET /api/v1/v21/boards/{id}/learning-events", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/projection": { "get": { "operationId": "v21_get_boards_by_id_projection", "summary": "GET /api/v1/v21/boards/{id}/projection", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/rules": { "post": { "operationId": "v21_post_boards_by_id_rules", "summary": "POST /api/v1/v21/boards/{id}/rules", "description": "Available while the `triggers` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `author_workflow_draft`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "triggers", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/schedules": { "post": { "operationId": "v21_post_boards_by_id_schedules", "summary": "POST /api/v1/v21/boards/{id}/schedules", "description": "Available while the `triggers` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_schedule`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "triggers", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/setups": { "post": { "operationId": "v21_post_boards_by_id_setups", "summary": "POST /api/v1/v21/boards/{id}/setups", "description": "Available while the `setup` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `setup_board`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "setup", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/stages": { "get": { "operationId": "v21_get_boards_by_id_stages", "summary": "GET /api/v1/v21/boards/{id}/stages", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "post": { "operationId": "v21_post_boards_by_id_stages", "summary": "POST /api/v1/v21/boards/{id}/stages", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_stages`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/stages/commands/reorder": { "post": { "operationId": "v21_post_boards_by_id_stages_commands_reorder", "summary": "POST /api/v1/v21/boards/{id}/stages/commands/reorder", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_stages`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/boards/{id}/work-folder": { "get": { "operationId": "v21_get_boards_by_id_work_folder", "summary": "GET /api/v1/v21/boards/{id}/work-folder", "description": "Available while the `reviews` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "reviews", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "put": { "operationId": "v21_put_boards_by_id_work_folder", "summary": "PUT /api/v1/v21/boards/{id}/work-folder", "description": "Available while the `reviews` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `set_work_folder`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "reviews", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/cards/{id}/connection-requests": { "get": { "operationId": "v21_get_cards_by_id_connection_requests", "summary": "GET /api/v1/v21/cards/{id}/connection-requests", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_request`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "post": { "operationId": "v21_post_cards_by_id_connection_requests", "summary": "POST /api/v1/v21/cards/{id}/connection-requests", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `request_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/cards/{id}/connection-requests/commands/preview": { "post": { "operationId": "v21_post_cards_by_id_connection_requests_commands_preview", "summary": "POST /api/v1/v21/cards/{id}/connection-requests/commands/preview", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `request_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/cards/{id}/deliveries": { "get": { "operationId": "v21_get_cards_by_id_deliveries", "summary": "GET /api/v1/v21/cards/{id}/deliveries", "description": "Available while the `destinations` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/cards/{id}/destination": { "put": { "operationId": "v21_put_cards_by_id_destination", "summary": "PUT /api/v1/v21/cards/{id}/destination", "description": "Available while the `destinations` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_destination`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/cards/{id}/files": { "get": { "operationId": "v21_get_cards_by_id_files", "summary": "GET /api/v1/v21/cards/{id}/files", "description": "Available while the `media` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `list_card_files`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "media", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/cards/{id}/files/link": { "post": { "operationId": "v21_post_cards_by_id_files_link", "summary": "POST /api/v1/v21/cards/{id}/files/link", "description": "Available while the `media` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `attach_link`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "media", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/cards/{id}/files/provider-file": { "post": { "operationId": "v21_post_cards_by_id_files_provider_file", "summary": "POST /api/v1/v21/cards/{id}/files/provider-file", "description": "Available while the `media` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `attach_provider_file`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "media", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/cards/{id}/files/transient-upload": { "post": { "operationId": "v21_post_cards_by_id_files_transient_upload", "summary": "POST /api/v1/v21/cards/{id}/files/transient-upload", "description": "Available while the `media` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `attach_local_file`, `prepare_transient_upload`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "media", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/cards/{id}/files/{file_id}/link": { "get": { "operationId": "v21_get_cards_by_id_files_by_file_id_link", "summary": "GET /api/v1/v21/cards/{id}/files/{file_id}/link", "description": "Available while the `media` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "media", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/cards/{id}/outputs/{output_id}": { "get": { "operationId": "v21_get_cards_by_id_outputs_by_output_id", "summary": "GET /api/v1/v21/cards/{id}/outputs/{output_id}", "description": "Available while the `media` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `get_output`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "output_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "media", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/cards/{id}/result": { "get": { "operationId": "v21_get_cards_by_id_result", "summary": "GET /api/v1/v21/cards/{id}/result", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-presets": { "get": { "operationId": "v21_get_connection_presets", "summary": "GET /api/v1/v21/connection-presets", "description": "Available while the `connections_oauth` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections_oauth", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-requests": { "get": { "operationId": "v21_get_connection_requests", "summary": "GET /api/v1/v21/connection-requests", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_request`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-requests/{id}": { "get": { "operationId": "v21_get_connection_requests_by_id", "summary": "GET /api/v1/v21/connection-requests/{id}", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_request`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-requests/{id}/commands/cancel": { "post": { "operationId": "v21_post_connection_requests_by_id_commands_cancel", "summary": "POST /api/v1/v21/connection-requests/{id}/commands/cancel", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_request`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-requests/{id}/commands/check-again": { "post": { "operationId": "v21_post_connection_requests_by_id_commands_check_again", "summary": "POST /api/v1/v21/connection-requests/{id}/commands/check-again", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_request`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-requests/{id}/commands/continue": { "post": { "operationId": "v21_post_connection_requests_by_id_commands_continue", "summary": "POST /api/v1/v21/connection-requests/{id}/commands/continue", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_request`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-requests/{id}/commands/give-up": { "post": { "operationId": "v21_post_connection_requests_by_id_commands_give_up", "summary": "POST /api/v1/v21/connection-requests/{id}/commands/give-up", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_request`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-steps/{id}": { "get": { "operationId": "v21_get_connection_steps_by_id", "summary": "GET /api/v1/v21/connection-steps/{id}", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_step`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "patch": { "operationId": "v21_patch_connection_steps_by_id", "summary": "PATCH /api/v1/v21/connection-steps/{id}", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_step`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-steps/{id}/commands/pause": { "post": { "operationId": "v21_post_connection_steps_by_id_commands_pause", "summary": "POST /api/v1/v21/connection-steps/{id}/commands/pause", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_step`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-steps/{id}/commands/resume": { "post": { "operationId": "v21_post_connection_steps_by_id_commands_resume", "summary": "POST /api/v1/v21/connection-steps/{id}/commands/resume", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_step`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-webhooks": { "get": { "operationId": "v21_get_connection_webhooks", "summary": "GET /api/v1/v21/connection-webhooks", "description": "Available while the `connections` and `connections_oauth` and `connection_webhooks` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_webhook`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "x-requires": [ "connections_oauth", "connection_webhooks" ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-webhooks/{id}": { "get": { "operationId": "v21_get_connection_webhooks_by_id", "summary": "GET /api/v1/v21/connection-webhooks/{id}", "description": "Available while the `connections` and `connections_oauth` and `connection_webhooks` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_webhook`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "x-requires": [ "connections_oauth", "connection_webhooks" ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-webhooks/{id}/commands/pause": { "post": { "operationId": "v21_post_connection_webhooks_by_id_commands_pause", "summary": "POST /api/v1/v21/connection-webhooks/{id}/commands/pause", "description": "Available while the `connections` and `connections_oauth` and `connection_webhooks` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_webhook`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "x-requires": [ "connections_oauth", "connection_webhooks" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-webhooks/{id}/commands/resume": { "post": { "operationId": "v21_post_connection_webhooks_by_id_commands_resume", "summary": "POST /api/v1/v21/connection-webhooks/{id}/commands/resume", "description": "Available while the `connections` and `connections_oauth` and `connection_webhooks` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_webhook`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "x-requires": [ "connections_oauth", "connection_webhooks" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connection-webhooks/{id}/events": { "get": { "operationId": "v21_get_connection_webhooks_by_id_events", "summary": "GET /api/v1/v21/connection-webhooks/{id}/events", "description": "Available while the `connections` and `connections_oauth` and `connection_webhooks` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_webhook`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "x-requires": [ "connections_oauth", "connection_webhooks" ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connections": { "get": { "operationId": "v21_get_connections", "summary": "GET /api/v1/v21/connections", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "post": { "operationId": "v21_post_connections", "summary": "POST /api/v1/v21/connections", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connections/commands/preview": { "post": { "operationId": "v21_post_connections_commands_preview", "summary": "POST /api/v1/v21/connections/commands/preview", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connections/{id}": { "delete": { "operationId": "v21_delete_connections_by_id", "summary": "DELETE /api/v1/v21/connections/{id}", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "get": { "operationId": "v21_get_connections_by_id", "summary": "GET /api/v1/v21/connections/{id}", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "patch": { "operationId": "v21_patch_connections_by_id", "summary": "PATCH /api/v1/v21/connections/{id}", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connections/{id}/commands/check-key": { "post": { "operationId": "v21_post_connections_by_id_commands_check_key", "summary": "POST /api/v1/v21/connections/{id}/commands/check-key", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connections/{id}/commands/disable": { "post": { "operationId": "v21_post_connections_by_id_commands_disable", "summary": "POST /api/v1/v21/connections/{id}/commands/disable", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connections/{id}/commands/enable": { "post": { "operationId": "v21_post_connections_by_id_commands_enable", "summary": "POST /api/v1/v21/connections/{id}/commands/enable", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connections/{id}/commands/lower-ceiling": { "post": { "operationId": "v21_post_connections_by_id_commands_lower_ceiling", "summary": "POST /api/v1/v21/connections/{id}/commands/lower-ceiling", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connections/{id}/commands/preview": { "post": { "operationId": "v21_post_connections_by_id_commands_preview", "summary": "POST /api/v1/v21/connections/{id}/commands/preview", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connections/{id}/commands/replace-key": { "post": { "operationId": "v21_post_connections_by_id_commands_replace_key", "summary": "POST /api/v1/v21/connections/{id}/commands/replace-key", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connections/{id}/key-checks/{key_check_id}": { "get": { "operationId": "v21_get_connections_by_id_key_checks_by_key_check_id", "summary": "GET /api/v1/v21/connections/{id}/key-checks/{key_check_id}", "description": "Available while the `connections` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "key_check_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connections/{id}/oauth": { "get": { "operationId": "v21_get_connections_by_id_oauth", "summary": "GET /api/v1/v21/connections/{id}/oauth", "description": "Available while the `connections` and `connections_oauth` capabilities are on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "x-requires": [ "connections_oauth" ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connections/{id}/oauth/prepare": { "post": { "operationId": "v21_post_connections_by_id_oauth_prepare", "summary": "POST /api/v1/v21/connections/{id}/oauth/prepare", "description": "Available while the `connections` and `connections_oauth` capabilities are on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "x-requires": [ "connections_oauth" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/connections/{id}/webhook": { "post": { "operationId": "v21_post_connections_by_id_webhook", "summary": "POST /api/v1/v21/connections/{id}/webhook", "description": "Available while the `connections` and `connections_oauth` and `connection_webhooks` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_webhook`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "x-requires": [ "connections_oauth", "connection_webhooks" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/deliveries/{id}": { "get": { "operationId": "v21_get_deliveries_by_id", "summary": "GET /api/v1/v21/deliveries/{id}", "description": "Available while the `destinations` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/deliveries/{id}/commands/redeliver": { "post": { "operationId": "v21_post_deliveries_by_id_commands_redeliver", "summary": "POST /api/v1/v21/deliveries/{id}/commands/redeliver", "description": "Available while the `destinations` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `redeliver`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/destinations": { "get": { "operationId": "v21_get_destinations", "summary": "GET /api/v1/v21/destinations", "description": "Available while the `destinations` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "post": { "operationId": "v21_post_destinations", "summary": "POST /api/v1/v21/destinations", "description": "Available while the `destinations` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_destination`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/destinations/commands/preview": { "post": { "operationId": "v21_post_destinations_commands_preview", "summary": "POST /api/v1/v21/destinations/commands/preview", "description": "Available while the `destinations` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "x-requires": [ "api_workflow" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/destinations/{id}": { "get": { "operationId": "v21_get_destinations_by_id", "summary": "GET /api/v1/v21/destinations/{id}", "description": "Available while the `destinations` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_destination`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "put": { "operationId": "v21_put_destinations_by_id", "summary": "PUT /api/v1/v21/destinations/{id}", "description": "Available while the `destinations` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_destination`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/destinations/{id}/commands/complete-oauth": { "post": { "operationId": "v21_post_destinations_by_id_commands_complete_oauth", "summary": "POST /api/v1/v21/destinations/{id}/commands/complete-oauth", "description": "Available while the `destinations` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_destination`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/destinations/{id}/commands/disable": { "post": { "operationId": "v21_post_destinations_by_id_commands_disable", "summary": "POST /api/v1/v21/destinations/{id}/commands/disable", "description": "Available while the `destinations` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_destination`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/destinations/{id}/commands/preview": { "post": { "operationId": "v21_post_destinations_by_id_commands_preview", "summary": "POST /api/v1/v21/destinations/{id}/commands/preview", "description": "Available while the `destinations` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "x-requires": [ "api_workflow" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/destinations/{id}/commands/test": { "post": { "operationId": "v21_post_destinations_by_id_commands_test", "summary": "POST /api/v1/v21/destinations/{id}/commands/test", "description": "Available while the `destinations` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_destination`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/destinations/{id}/commands/test-call": { "post": { "operationId": "v21_post_destinations_by_id_commands_test_call", "summary": "POST /api/v1/v21/destinations/{id}/commands/test-call", "description": "Available while the `destinations` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "x-requires": [ "api_workflow" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/destinations/{id}/test-calls/{test_call_id}": { "get": { "operationId": "v21_get_destinations_by_id_test_calls_by_test_call_id", "summary": "GET /api/v1/v21/destinations/{id}/test-calls/{test_call_id}", "description": "Available while the `destinations` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "test_call_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "x-requires": [ "api_workflow" ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/device-pairings/redeem": { "post": { "operationId": "v21_post_device_pairings_redeem", "summary": "POST /api/v1/v21/device-pairings/redeem", "description": "Available while the `media` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `pair_device`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "media", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/devices/{id}/files": { "post": { "operationId": "v21_post_devices_by_id_files", "summary": "POST /api/v1/v21/devices/{id}/files", "description": "Available while the `media` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `pair_device`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "media", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/devices/{id}/heartbeat": { "post": { "operationId": "v21_post_devices_by_id_heartbeat", "summary": "POST /api/v1/v21/devices/{id}/heartbeat", "description": "Available while the `media` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "media", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/dispatch/commands/pause": { "post": { "operationId": "v21_post_dispatch_commands_pause", "summary": "POST /api/v1/v21/dispatch/commands/pause", "description": "Available while the `dispatch` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `pause_workspace_dispatch`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "dispatch", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/dispatch/commands/resume": { "post": { "operationId": "v21_post_dispatch_commands_resume", "summary": "POST /api/v1/v21/dispatch/commands/resume", "description": "Available while the `dispatch` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `resume_workspace_dispatch`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "dispatch", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/inbound-endpoints": { "get": { "operationId": "v21_get_inbound_endpoints", "summary": "GET /api/v1/v21/inbound-endpoints", "description": "Available while the `inbound` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_inbound_endpoint`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "inbound", "x-requires": [ "api_workflow" ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "post": { "operationId": "v21_post_inbound_endpoints", "summary": "POST /api/v1/v21/inbound-endpoints", "description": "Available while the `inbound` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_inbound_endpoint`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "inbound", "x-requires": [ "api_workflow" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/inbound-endpoints/{id}": { "get": { "operationId": "v21_get_inbound_endpoints_by_id", "summary": "GET /api/v1/v21/inbound-endpoints/{id}", "description": "Available while the `inbound` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_inbound_endpoint`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "inbound", "x-requires": [ "api_workflow" ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "put": { "operationId": "v21_put_inbound_endpoints_by_id", "summary": "PUT /api/v1/v21/inbound-endpoints/{id}", "description": "Available while the `inbound` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_inbound_endpoint`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "inbound", "x-requires": [ "api_workflow" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/inbound-endpoints/{id}/commands/disable": { "post": { "operationId": "v21_post_inbound_endpoints_by_id_commands_disable", "summary": "POST /api/v1/v21/inbound-endpoints/{id}/commands/disable", "description": "Available while the `inbound` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_inbound_endpoint`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "inbound", "x-requires": [ "api_workflow" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/job-steps/{id}": { "get": { "operationId": "v21_get_job_steps_by_id", "summary": "GET /api/v1/v21/job-steps/{id}", "description": "Available while the `external_jobs` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_job_step`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "external_jobs", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/job-steps/{id}/commands/pause": { "post": { "operationId": "v21_post_job_steps_by_id_commands_pause", "summary": "POST /api/v1/v21/job-steps/{id}/commands/pause", "description": "Available while the `external_jobs` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_job_step`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "external_jobs", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/job-steps/{id}/commands/resume": { "post": { "operationId": "v21_post_job_steps_by_id_commands_resume", "summary": "POST /api/v1/v21/job-steps/{id}/commands/resume", "description": "Available while the `external_jobs` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_job_step`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "external_jobs", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/member-mappings": { "get": { "operationId": "v21_get_member_mappings", "summary": "GET /api/v1/v21/member-mappings", "description": "Available while the `inbound` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_member_mapping`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "inbound", "x-requires": [ "api_workflow" ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "post": { "operationId": "v21_post_member_mappings", "summary": "POST /api/v1/v21/member-mappings", "description": "Available while the `inbound` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_member_mapping`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "inbound", "x-requires": [ "api_workflow" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/member-mappings/{id}/commands/remove": { "post": { "operationId": "v21_post_member_mappings_by_id_commands_remove", "summary": "POST /api/v1/v21/member-mappings/{id}/commands/remove", "description": "Available while the `inbound` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_member_mapping`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "inbound", "x-requires": [ "api_workflow" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/questions": { "get": { "operationId": "v21_get_questions", "summary": "GET /api/v1/v21/questions", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/results": { "get": { "operationId": "v21_get_results", "summary": "GET /api/v1/v21/results", "description": "Available while the `destinations` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `list_results`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "destinations", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/reviews": { "get": { "operationId": "v21_get_reviews", "summary": "GET /api/v1/v21/reviews", "description": "Available while the `reviews` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `list_reviews`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "reviews", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/reviews/{id}": { "get": { "operationId": "v21_get_reviews_by_id", "summary": "GET /api/v1/v21/reviews/{id}", "description": "Available while the `reviews` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `get_review`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "reviews", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/reviews/{id}/commands/decide": { "post": { "operationId": "v21_post_reviews_by_id_commands_decide", "summary": "POST /api/v1/v21/reviews/{id}/commands/decide", "description": "Available while the `reviews` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `decide_review`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "reviews", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/rules/{id}/commands/pause": { "post": { "operationId": "v21_post_rules_by_id_commands_pause", "summary": "POST /api/v1/v21/rules/{id}/commands/pause", "description": "Available while the `triggers` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "triggers", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/rules/{id}/commands/publish": { "post": { "operationId": "v21_post_rules_by_id_commands_publish", "summary": "POST /api/v1/v21/rules/{id}/commands/publish", "description": "Available while the `triggers` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `publish_workflow`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "triggers", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/runner-devices": { "get": { "operationId": "v21_get_runner_devices", "summary": "GET /api/v1/v21/runner-devices", "description": "Available while the `runner` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "runner", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/runner/claim": { "post": { "operationId": "v21_post_runner_claim", "summary": "POST /api/v1/v21/runner/claim", "description": "Available while the `runner` capability is on; otherwise it answers 409 CAPABILITY_OFF. Runner key only: this route accepts only a runner-preset token, used by bakedbrie-runner.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "runner", "x-token-preset": "runner", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/runner/heartbeat": { "post": { "operationId": "v21_post_runner_heartbeat", "summary": "POST /api/v1/v21/runner/heartbeat", "description": "Available while the `runner` capability is on; otherwise it answers 409 CAPABILITY_OFF. Runner key only: this route accepts only a runner-preset token, used by bakedbrie-runner.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "runner", "x-token-preset": "runner", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/runner/hello": { "post": { "operationId": "v21_post_runner_hello", "summary": "POST /api/v1/v21/runner/hello", "description": "Available while the `runner` capability is on; otherwise it answers 409 CAPABILITY_OFF. Runner key only: this route accepts only a runner-preset token, used by bakedbrie-runner.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "runner", "x-token-preset": "runner", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/runner/runs/{id}/complete": { "post": { "operationId": "v21_post_runner_runs_by_id_complete", "summary": "POST /api/v1/v21/runner/runs/{id}/complete", "description": "Available while the `runner` capability is on; otherwise it answers 409 CAPABILITY_OFF. Runner key only: this route accepts only a runner-preset token, used by bakedbrie-runner.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "runner", "x-token-preset": "runner", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/runner/runs/{id}/fail": { "post": { "operationId": "v21_post_runner_runs_by_id_fail", "summary": "POST /api/v1/v21/runner/runs/{id}/fail", "description": "Available while the `runner` capability is on; otherwise it answers 409 CAPABILITY_OFF. Runner key only: this route accepts only a runner-preset token, used by bakedbrie-runner.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "runner", "x-token-preset": "runner", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/runner/runs/{id}/start": { "post": { "operationId": "v21_post_runner_runs_by_id_start", "summary": "POST /api/v1/v21/runner/runs/{id}/start", "description": "Available while the `runner` capability is on; otherwise it answers 409 CAPABILITY_OFF. Runner key only: this route accepts only a runner-preset token, used by bakedbrie-runner.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "runner", "x-token-preset": "runner", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/runner/runs/{id}/uploads": { "post": { "operationId": "v21_post_runner_runs_by_id_uploads", "summary": "POST /api/v1/v21/runner/runs/{id}/uploads", "description": "Available while the `runner` capability is on; otherwise it answers 409 CAPABILITY_OFF. Runner key only: this route accepts only a runner-preset token, used by bakedbrie-runner.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "runner", "x-token-preset": "runner", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/schedule-runs/{id}/cards": { "post": { "operationId": "v21_post_schedule_runs_by_id_cards", "summary": "POST /api/v1/v21/schedule-runs/{id}/cards", "description": "Available while the `triggers` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "triggers", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/schedules/{id}/commands/pause": { "post": { "operationId": "v21_post_schedules_by_id_commands_pause", "summary": "POST /api/v1/v21/schedules/{id}/commands/pause", "description": "Available while the `triggers` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "triggers", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/schedules/{id}/commands/publish": { "post": { "operationId": "v21_post_schedules_by_id_commands_publish", "summary": "POST /api/v1/v21/schedules/{id}/commands/publish", "description": "Available while the `triggers` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "triggers", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/schedules/{id}/commands/resume": { "post": { "operationId": "v21_post_schedules_by_id_commands_resume", "summary": "POST /api/v1/v21/schedules/{id}/commands/resume", "description": "Available while the `triggers` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "triggers", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/schedules/{id}/commands/run-now": { "post": { "operationId": "v21_post_schedules_by_id_commands_run_now", "summary": "POST /api/v1/v21/schedules/{id}/commands/run-now", "description": "Available while the `triggers` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_schedule`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "triggers", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/schedules/{id}/history": { "get": { "operationId": "v21_get_schedules_by_id_history", "summary": "GET /api/v1/v21/schedules/{id}/history", "description": "Available while the `triggers` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "triggers", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/schedules/{id}/preview": { "get": { "operationId": "v21_get_schedules_by_id_preview", "summary": "GET /api/v1/v21/schedules/{id}/preview", "description": "Available while the `triggers` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "triggers", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/secret-drops": { "post": { "operationId": "v21_post_secret_drops", "summary": "POST /api/v1/v21/secret-drops", "description": "Available while the `secrets` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `prepare_secret`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "secrets", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/secret-drops/{id}": { "put": { "operationId": "v21_put_secret_drops_by_id", "summary": "PUT /api/v1/v21/secret-drops/{id}", "description": "Available while the `secrets` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `prepare_secret`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "secrets", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/setups/{id}/commands/undo": { "post": { "operationId": "v21_post_setups_by_id_commands_undo", "summary": "POST /api/v1/v21/setups/{id}/commands/undo", "description": "Available while the `setup` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `undo_setup`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "setup", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/slack-app/installs": { "get": { "operationId": "v21_get_slack_app_installs", "summary": "GET /api/v1/v21/slack-app/installs", "description": "Available while the `slack_app` and `inbound` and `api_workflow` capabilities are on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "slack_app", "x-requires": [ "inbound", "api_workflow" ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/stages/{id}": { "delete": { "operationId": "v21_delete_stages_by_id", "summary": "DELETE /api/v1/v21/stages/{id}", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_stages`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "put": { "operationId": "v21_put_stages_by_id", "summary": "PUT /api/v1/v21/stages/{id}", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_stages`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/trigger-sources/{id}": { "get": { "operationId": "v21_get_trigger_sources_by_id", "summary": "GET /api/v1/v21/trigger-sources/{id}", "description": "Available while the `triggers` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `get_trigger_source`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "triggers", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/triggers": { "get": { "operationId": "v21_get_triggers", "summary": "GET /api/v1/v21/triggers", "description": "Available while the `triggers` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `list_triggers`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "triggers", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/uploads/{id}": { "put": { "operationId": "v21_put_uploads_by_id", "summary": "PUT /api/v1/v21/uploads/{id}", "description": "Available while the `media` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `attach_local_file`, `prepare_transient_upload`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "media", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/webhook-rules/{id}": { "get": { "operationId": "v21_get_webhook_rules_by_id", "summary": "GET /api/v1/v21/webhook-rules/{id}", "description": "Available while the `connections` and `connections_oauth` and `connection_webhooks` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_webhook`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "x-requires": [ "connections_oauth", "connection_webhooks" ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "patch": { "operationId": "v21_patch_webhook_rules_by_id", "summary": "PATCH /api/v1/v21/webhook-rules/{id}", "description": "Available while the `connections` and `connections_oauth` and `connection_webhooks` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_webhook`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "x-requires": [ "connections_oauth", "connection_webhooks" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/webhook-rules/{id}/commands/pause": { "post": { "operationId": "v21_post_webhook_rules_by_id_commands_pause", "summary": "POST /api/v1/v21/webhook-rules/{id}/commands/pause", "description": "Available while the `connections` and `connections_oauth` and `connection_webhooks` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_webhook`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "x-requires": [ "connections_oauth", "connection_webhooks" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/webhook-rules/{id}/commands/resume": { "post": { "operationId": "v21_post_webhook_rules_by_id_commands_resume", "summary": "POST /api/v1/v21/webhook-rules/{id}/commands/resume", "description": "Available while the `connections` and `connections_oauth` and `connection_webhooks` capabilities are on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `manage_connection_webhook`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "connections", "x-requires": [ "connections_oauth", "connection_webhooks" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/whoami": { "get": { "operationId": "v21_get_whoami", "summary": "GET /api/v1/v21/whoami", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `whoami`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/workspace/commands/rename": { "post": { "operationId": "v21_post_workspace_commands_rename", "summary": "POST /api/v1/v21/workspace/commands/rename", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF. MCP tool: `rename_workspace`.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "If-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/workspace/sender-profiles": { "get": { "operationId": "v21_get_workspace_sender_profiles", "summary": "GET /api/v1/v21/workspace/sender-profiles", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/api/v1/v21/workspace/suppressions": { "get": { "operationId": "v21_get_workspace_suppressions", "summary": "GET /api/v1/v21/workspace/suppressions", "description": "Available while the `control` capability is on; otherwise it answers 409 CAPABILITY_OFF.", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "scopedBearer": [] } ], "x-capability": "control", "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "default": { "description": "Refusal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } } }, "components": { "securitySchemes": { "scopedBearer": { "type": "http", "scheme": "bearer", "description": "Personal API token minted from an interactive session." } }, "schemas": { "ErrorEnvelope": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "path": { "maxItems": 32, "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } ] } }, "code": { "type": "string", "minLength": 1, "maxLength": 100 }, "message": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "path", "code", "message" ], "additionalProperties": false } }, "retryable": { "type": "boolean" }, "current_revision": { "type": "string", "maxLength": 19, "pattern": "^(?:[1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6][0-9]{0}|9223372036854775807)$" } }, "required": [ "code", "message", "fields", "retryable" ], "additionalProperties": false }, "request_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "receipt_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "type": "null" } ] } }, "required": [ "error", "request_id", "receipt_id" ], "additionalProperties": false }, "Envelope": { "type": "object", "properties": { "data": {}, "request_id": { "type": "string" }, "receipt_id": { "type": [ "string", "null" ] } }, "required": [ "data" ] } } } }