# Replace workflow state (/api-reference/workflows/replaceWorkflowState) `PUT /api/v2/workflows/{workflowId}/state` Replace the draft graph in one write. Requires workspace write access. Concurrent row-locked writes are last-write-wins; IDs owned by another workflow return `409`. Deployments, schedules, and webhook registrations are unchanged. Deploy to serve the edits. Lint is advisory. Use `dryRun=true` to validate without saving, auditing, or notifying collaborators. Workspace API keys return `403`; use a personal API key or scoped OAuth token. OAuth scope: `api:write`. ## Authentication ```json { "requirements": [ { "apiKey": [] }, { "oauthBearer": [ "api:write" ] } ], "schemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "X-API-Key", "description": "Send a personal or workspace API key in `X-API-Key`. See [key types and access](https://docs.sim.ai/api-reference/authentication#key-types); operations that reject workspace keys say so in their description." }, "oauthBearer": { "type": "oauth2", "description": "Send a Sim OAuth access token in `Authorization: Bearer`. See [OAuth authentication and scopes](https://docs.sim.ai/api-reference/authentication#oauth-access-tokens).", "flows": { "authorizationCode": { "authorizationUrl": "https://www.sim.ai/api/auth/oauth2/authorize", "tokenUrl": "https://www.sim.ai/api/auth/oauth2/token", "refreshUrl": "https://www.sim.ai/api/auth/oauth2/token", "scopes": { "api:read": "Read your workspaces, workflows, files, tables, and logs", "api:write": "Read, create, change, run, and delete resources in your workspaces", "offline_access": "Stay signed in without asking again" } } } } } } ``` Required OAuth scope: `api:write`. ## Request examples ### cURL ```bash curl --request PUT 'https://www.sim.ai/api/v2/workflows/3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36/state' \ --header 'X-API-Key: YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "blocks": {}, "edges": [] }' ``` ### JavaScript ```javascript const response = await fetch("https://www.sim.ai/api/v2/workflows/3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36/state", { "method": "PUT", "headers": { "X-API-Key": "YOUR_API_KEY", "Content-Type": "application/json" }, "body": "{\n \"blocks\": {},\n \"edges\": []\n}" }); if (!response.ok) throw new Error(`HTTP ${response.status}`); const result = await response.json(); ``` ### Python ```python import requests response = requests.request( "PUT", "https://www.sim.ai/api/v2/workflows/3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36/state", headers={ "X-API-Key": "YOUR_API_KEY", "Content-Type": "application/json" }, data="{\n \"blocks\": {},\n \"edges\": []\n}", ) response.raise_for_status() result = response.json() ``` ### Go ```go package main import ( "io" "net/http" "os" "strings" ) func check(err error) { if err != nil { panic(err) } } func must[T any](value T, err error) T { check(err) return value } func main() { request := must(http.NewRequest("PUT", "https://www.sim.ai/api/v2/workflows/3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36/state", strings.NewReader("{\n \"blocks\": {},\n \"edges\": []\n}"))) request.Header.Set("X-API-Key", "YOUR_API_KEY") request.Header.Set("Content-Type", "application/json") response := must(http.DefaultClient.Do(request)) defer response.Body.Close() if response.StatusCode >= 400 { panic(response.Status) } must(io.Copy(os.Stdout, response.Body)) } ``` ### Java ```java import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class Example { public static void main(String[] args) throws Exception { var builder = HttpRequest.newBuilder(URI.create("https://www.sim.ai/api/v2/workflows/3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36/state")); builder.header("X-API-Key", "YOUR_API_KEY"); builder.header("Content-Type", "application/json"); var request = builder.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"blocks\": {},\n \"edges\": []\n}")).build(); var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofInputStream()); try (var body = response.body()) { if (response.statusCode() >= 400) throw new IllegalStateException("HTTP " + response.statusCode()); body.transferTo(System.out); } } } ``` ### C# ```csharp using System; using System.IO; using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(new HttpMethod("PUT"), "https://www.sim.ai/api/v2/workflows/3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36/state"); request.Content = new StringContent("{\n \"blocks\": {},\n \"edges\": []\n}", Encoding.UTF8); request.Headers.TryAddWithoutValidation("X-API-Key", "YOUR_API_KEY"); request.Content!.Headers.ContentType = System.Net.Http.Headers.MediaTypeHeaderValue.Parse("application/json"); using var response = await client.SendAsync(request, HttpCompletionOption.ResponseHeadersRead); response.EnsureSuccessStatusCode(); await response.Content.CopyToAsync(Console.OpenStandardOutput()); ``` ## Parameters ```json [ { "name": "workflowId", "in": "path", "required": true, "description": "Unique workflow identifier.", "schema": { "type": "string", "minLength": 1, "description": "Unique workflow identifier.", "examples": [ "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36" ] } }, { "name": "dryRun", "in": "query", "required": false, "description": "Validate and lint without writing, auditing, or notifying collaborators. Returns the same validation, preparation warnings, lint findings, and ID-ownership conflicts (`409`) as a committed write. `needsRedeployment` describes the pre-write state. For semantic operations, `mintedBlockIds` is empty; `previewBlockIds` contains provisional IDs with a warning, since committing mints new IDs.", "schema": { "description": "Validate and lint without writing, auditing, or notifying collaborators. Returns the same validation, preparation warnings, lint findings, and ID-ownership conflicts (`409`) as a committed write. `needsRedeployment` describes the pre-write state. For semantic operations, `mintedBlockIds` is empty; `previewBlockIds` contains provisional IDs with a warning, since committing mints new IDs.", "type": "boolean" } } ] ``` ## Request body ```json { "required": true, "description": "A complete replacement draft graph for a workflow.", "content": { "application/json": { "schema": { "type": "object", "properties": { "blocks": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Block identifier, unique within the workflow." }, "type": { "type": "string", "minLength": 1, "description": "Registered block type." }, "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Block display name; must be unique within the workflow." }, "position": { "type": "object", "properties": { "x": { "type": "number", "description": "Canvas x coordinate." }, "y": { "type": "number", "description": "Canvas y coordinate." } }, "required": [ "x", "y" ], "description": "Canvas coordinates of a block." }, "subBlocks": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Sub-block identifier." }, "type": { "type": "string", "minLength": 1, "description": "Sub-block input type." }, "value": { "description": "Configured value; shape depends on the sub-block type." } }, "required": [ "id", "type", "value" ], "description": "One configurable input on a block." }, "description": "Configured inputs keyed by sub-block id." }, "outputs": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "Declared shape of one output; depends on the block type." }, "description": "Declared output shape keyed by output name." }, "enabled": { "type": "boolean", "description": "Whether the block runs." }, "horizontalHandles": { "description": "Whether edge handles render horizontally.", "type": "boolean" }, "height": { "description": "Rendered block height.", "type": "number" }, "advancedMode": { "description": "Whether the block is edited in advanced mode.", "type": "boolean" }, "errorEnabled": { "description": "Whether the block exposes an error branch.", "type": "boolean" }, "retry": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether the block retries on failure." }, "maxTries": { "type": "integer", "minimum": 2, "maximum": 5, "description": "Total attempts, including the first." }, "waitBetweenTriesMs": { "type": "integer", "minimum": 0, "maximum": 5000, "description": "Delay between attempts, in milliseconds." } }, "required": [ "enabled", "maxTries", "waitBetweenTriesMs" ], "description": "Per-block retry configuration." }, "triggerMode": { "description": "Whether the block acts as the workflow trigger.", "type": "boolean" }, "data": { "type": "object", "properties": { "parentId": { "description": "Identifier of the containing loop or parallel.", "type": "string" }, "extent": { "description": "Constrains the block to its parent bounds.", "type": "string", "const": "parent" }, "width": { "description": "Rendered container width.", "type": "number" }, "height": { "description": "Rendered container height.", "type": "number" }, "collection": { "description": "Items a forEach loop or collection parallel iterates." }, "count": { "description": "Iteration count for a `for` loop or count parallel.", "type": "number" }, "loopType": { "description": "Loop container kind.", "type": "string", "enum": [ "for", "forEach", "while", "doWhile" ] }, "whileCondition": { "description": "Condition expression for a `while` loop.", "type": "string" }, "doWhileCondition": { "description": "Condition expression for a `doWhile` loop.", "type": "string" }, "parallelType": { "description": "Parallel container kind.", "type": "string", "enum": [ "collection", "count" ] }, "batchSize": { "description": "Maximum concurrent branches of a parallel.", "type": "number" }, "type": { "description": "Container subtype.", "type": "string" }, "canonicalModes": { "description": "Per-field editing mode, keyed by canonical parameter id.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string", "enum": [ "basic", "advanced" ] } } }, "description": "Container and layout metadata carried by a block." }, "locked": { "description": "Whether the block is locked against edits.", "type": "boolean" } }, "required": [ "id", "type", "name", "position", "subBlocks", "outputs", "enabled" ], "title": "Workflow block", "description": "One node of a workflow graph and its configuration." }, "description": "Blocks keyed by block id." }, "edges": { "maxItems": 10000, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Edge identifier, unique within the workflow." }, "source": { "type": "string", "minLength": 1, "description": "Source block id." }, "target": { "type": "string", "minLength": 1, "description": "Target block id." }, "sourceHandle": { "description": "Source port, or null for the block default.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "targetHandle": { "description": "Target port, or null for the block default.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "description": "Edge renderer type.", "type": "string" } }, "required": [ "id", "source", "target" ], "title": "Workflow edge", "description": "A directed connection between two blocks." }, "description": "Directed connections between blocks." }, "loops": { "description": "Ignored on write: loop containers are recomputed from `blocks`.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "description": "Loop container identifier; equal to the loop block id." }, "nodes": { "type": "array", "items": { "type": "string" }, "description": "Block ids inside the loop." }, "iterations": { "type": "number", "description": "Resolved iteration count." }, "loopType": { "type": "string", "enum": [ "for", "forEach", "while", "doWhile" ], "description": "Loop kind." }, "forEachItems": { "description": "Items a forEach loop iterates, or the expression producing them.", "anyOf": [ { "type": "array", "items": { "description": "One item the loop iterates." } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "One item the loop iterates." } }, { "type": "string" } ] }, "whileCondition": { "description": "Condition expression for a `while` loop.", "type": "string" }, "doWhileCondition": { "description": "Condition expression for a `doWhile` loop.", "type": "string" }, "enabled": { "description": "Whether the loop runs.", "type": "boolean" }, "locked": { "description": "Whether the loop is locked against edits.", "type": "boolean" } }, "required": [ "id", "nodes", "iterations", "loopType" ], "title": "Workflow loop", "description": "A loop container derived from the workflow blocks." } }, "parallels": { "description": "Ignored on write: parallel containers are recomputed from `blocks`.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "description": "Parallel container identifier; equal to the parallel block id." }, "nodes": { "type": "array", "items": { "type": "string" }, "description": "Block ids inside the parallel." }, "distribution": { "description": "Items distributed across branches, or the expression producing them.", "anyOf": [ { "type": "array", "items": { "description": "One item distributed to a branch." } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "One item distributed to a branch." } }, { "type": "string" } ] }, "count": { "description": "Fixed branch count.", "type": "number" }, "parallelType": { "description": "Parallel kind.", "type": "string", "enum": [ "count", "collection" ] }, "batchSize": { "description": "Maximum concurrent branches.", "type": "number" }, "enabled": { "description": "Whether the parallel runs.", "type": "boolean" }, "locked": { "description": "Whether the parallel is locked against edits.", "type": "boolean" } }, "required": [ "id", "nodes" ], "title": "Workflow parallel", "description": "A parallel container derived from the workflow blocks." } }, "variables": { "description": "Replacement variable set. Omit to leave the stored variables untouched.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Variable identifier." }, "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Variable name, referenced from block inputs." }, "type": { "type": "string", "enum": [ "string", "number", "boolean", "object", "array", "plain" ], "description": "Declared variable type." }, "value": { "description": "Variable value; free-form and validated per `type` at use time." } }, "required": [ "id", "name", "type", "value" ], "title": "Workflow variable", "description": "A workflow-scoped variable." } } }, "required": [ "blocks", "edges" ], "additionalProperties": false, "title": "Replace workflow state request", "description": "A complete replacement draft graph for a workflow.", "examples": [ { "blocks": {}, "edges": [] } ] }, "examples": { "example1": { "summary": "Request example 1", "value": { "blocks": {}, "edges": [] } } } } } } ``` ## Responses ### 200 ```json { "description": "The draft graph was replaced.", "headers": { "X-RateLimit-Limit": { "description": "Maximum requests allowed in the current window.", "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "title": "Rate limit", "description": "Maximum requests allowed in the current window." } }, "X-RateLimit-Remaining": { "description": "Requests remaining in the current window.", "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "title": "Rate limit remaining", "description": "Requests remaining in the current window." } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the current rate-limit window resets.", "schema": { "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))$", "title": "Rate limit reset", "description": "ISO 8601 timestamp when the current rate-limit window resets." } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the workflow whose draft graph was written." }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Non-fatal notes about blocks and edges that were normalized or dropped before persistence. Empty when there was nothing to report." }, "needsRedeployment": { "type": "boolean", "description": "Whether the live deployment differs from the draft. A graph write never changes what the deployed endpoint serves; deploy to publish it. On a dry run, this describes the state before the proposed write." }, "lint": { "type": "object", "properties": { "sources": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." } }, "required": [ "blockId", "blockName", "blockType" ], "additionalProperties": false }, "description": "Blocks with no incoming edge. A trigger block is naturally a source; anything else here is unreachable." }, "sinks": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." } }, "required": [ "blockId", "blockName", "blockType" ], "additionalProperties": false }, "description": "Blocks with no outgoing edge." }, "orphanBlocks": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." } }, "required": [ "blockId", "blockName", "blockType" ], "additionalProperties": false }, "description": "Blocks with neither an incoming nor an outgoing edge." }, "emptyOutgoingPorts": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." }, "handle": { "type": "string", "description": "Source handle with nothing connected to it." }, "label": { "type": "string", "description": "Human-readable name of the port." } }, "required": [ "blockId", "blockName", "blockType", "handle", "label" ], "additionalProperties": false }, "description": "Branch and container ports that lead nowhere." }, "invalidBranchPorts": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." }, "sourceHandle": { "type": "string", "description": "Source handle that does not match the block." }, "reason": { "type": "string", "description": "Why the handle is not valid for this block." } }, "required": [ "blockId", "blockName", "blockType", "sourceHandle", "reason" ], "additionalProperties": false }, "description": "Condition and router edges whose source handle names no real branch." }, "invalidConnectionTargets": { "type": "array", "items": { "type": "object", "properties": { "sourceBlockId": { "type": "string", "description": "Block the edge leaves." }, "sourceBlockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the source block." }, "sourceHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle the edge leaves from." }, "targetBlockId": { "type": "string", "description": "Block the edge points at." }, "reason": { "type": "string", "description": "Why the target is not a legal destination." } }, "required": [ "sourceBlockId", "sourceBlockName", "sourceHandle", "targetBlockId", "reason" ], "additionalProperties": false }, "description": "Edges pointing at a block that cannot legally receive them." }, "fieldIssues": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." }, "missingRequiredFields": { "type": "array", "items": { "type": "string" }, "description": "Required sub-block fields that resolve empty in the active mode." }, "inactiveModeValues": { "type": "array", "items": { "type": "object", "properties": { "canonicalId": { "type": "string", "description": "Canonical parameter the two sub-block modes share." }, "activeMemberId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sub-block the runtime reads, where the value should live." }, "inactiveMemberId": { "type": "string", "description": "Sub-block holding the stranded value, which the runtime ignores." }, "kind": { "type": "string", "enum": [ "credential", "resource", "other" ], "description": "What kind of value is stranded." } }, "required": [ "canonicalId", "activeMemberId", "inactiveMemberId", "kind" ], "additionalProperties": false }, "description": "Values stranded on the inactive member of a canonical pair." } }, "required": [ "blockId", "blockName", "blockType", "missingRequiredFields", "inactiveModeValues" ], "additionalProperties": false }, "description": "Per-block configuration problems. The most actionable part of the report for a headless graph builder: a block missing a required field will fail at run time." }, "unresolvedReferences": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." }, "field": { "type": "string", "description": "Sub-block field holding the reference." }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "The reference, or references, that did not resolve." }, "kind": { "type": "string", "enum": [ "credential", "resource", "custom-tool", "mcp-tool", "skill", "block-output" ], "description": "What kind of entity the reference was expected to name." }, "reason": { "type": "string", "description": "Why the reference does not resolve." } }, "required": [ "blockId", "blockName", "blockType", "field", "value", "kind", "reason" ], "additionalProperties": false }, "description": "Credential, resource, tool, and skill references that do not resolve; `block-output` references that will not work as written: a block that does not exist, or an output field the block does not have (reason `unknown-field`); and text outputs written unquoted in a JSON field (reason `unquoted-json-string`), which leave the field invalid JSON at run time unless the text is itself JSON. These values are still persisted; they are reported, not dropped." }, "tableFieldIssues": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." }, "field": { "type": "string", "description": "The filter or sort field that names no column." }, "tableName": { "type": "string", "description": "Display name of the table the block is bound to." } }, "required": [ "blockId", "blockName", "blockType", "field", "tableName" ], "additionalProperties": false }, "description": "Table block `filter` and `order` fields checked against the bound table's live schema that name no column (nor the implicit `id`, `createdAt`, `updatedAt`). Such a run fails inside the block's error edge. A filter holding a `` reference, or one that is not JSON, is not checked." }, "manualRunIssue": { "anyOf": [ { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "no-trigger", "multiple-api-triggers", "trigger-not-connected" ], "description": "Why the run is refused." }, "message": { "type": "string", "description": "The error the manual run raises." }, "blockId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Trigger the run would start from, when the problem is that trigger." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of that trigger." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of that trigger." } }, "required": [ "reason", "message", "blockId", "blockName", "blockType" ], "additionalProperties": false }, { "type": "null" } ], "description": "Why a manual run from the editor's Run button would be refused before it starts: no enabled trigger it can start from, more than one API trigger, or a selected trigger with no outgoing connection. The API run endpoints do not apply these checks. `null` when no manual-run issue is reported: the run can begin, only a chat trigger can start the workflow, or the graph is empty (reported in `notes` instead)." }, "notes": { "type": "array", "items": { "type": "string" }, "description": "Advisory notes about the report itself." } }, "required": [ "sources", "sinks", "orphanBlocks", "emptyOutgoingPorts", "invalidBranchPorts", "invalidConnectionTargets", "fieldIssues", "unresolvedReferences", "tableFieldIssues", "manualRunIssue", "notes" ], "additionalProperties": false, "title": "Workflow lint report", "description": "Advisory findings about a saved graph. Findings never block a write or a deploy; they tell a caller what will misbehave at run time." }, "dryRun": { "type": "boolean", "description": "Whether this request only validated. `true` means nothing was persisted; the findings describe what a committed write of the same body would produce." } }, "required": [ "id", "warnings", "needsRedeployment", "lint", "dryRun" ], "additionalProperties": false, "title": "Replace workflow state result", "description": "Response data." } }, "required": [ "data" ], "additionalProperties": false, "title": "Replace workflow state response", "description": "Outcome of replacing a workflow draft graph.", "examples": [ { "data": { "id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36", "warnings": [], "needsRedeployment": true, "dryRun": false, "lint": { "sources": [], "sinks": [], "orphanBlocks": [], "emptyOutgoingPorts": [], "invalidBranchPorts": [], "invalidConnectionTargets": [], "fieldIssues": [], "unresolvedReferences": [], "tableFieldIssues": [], "manualRunIssue": null, "notes": [] } } } ] }, "examples": { "example1": { "summary": "Response example 1", "value": { "data": { "id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36", "warnings": [], "needsRedeployment": true, "dryRun": false, "lint": { "sources": [], "sinks": [], "orphanBlocks": [], "emptyOutgoingPorts": [], "invalidBranchPorts": [], "invalidConnectionTargets": [], "fieldIssues": [], "unresolvedReferences": [], "tableFieldIssues": [], "manualRunIssue": null, "notes": [] } } } } } } } } ``` ### 400 ```json { "description": "The request is invalid. This includes a query parameter sent with no value (`?limit=`, `?search=`), which is rejected rather than read as zero, empty, or the parameter default — omit the parameter instead.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable machine-readable error code." }, "message": { "type": "string", "description": "Human-readable explanation of the error." }, "details": { "description": "Structured error context whose keys depend on the error. Actionable `403` responses use the `V2ActionableForbiddenDetails` shape; validation failures may return issue arrays instead.", "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "INSUFFICIENT_WORKSPACE_ROLE", "PERSONAL_API_KEYS_DISABLED", "WORKSPACE_KEY_OPERATION_NOT_PERMITTED", "PRINCIPAL_KIND_NOT_PERMITTED", "ORGANIZATION_MEMBERSHIP_REQUIRED", "ORGANIZATION_ADMIN_REQUIRED", "ENTERPRISE_PLAN_REQUIRED", "SSO_DISABLED", "SSO_DOMAIN_NOT_VERIFIED", "SSO_PROVIDER_LIMIT_REACHED", "ORGANIZATION_PLAN_REQUIRED", "AUDIT_LOGS_DISABLED", "ACCESS_REQUESTS_DISABLED", "ACCESS_REQUEST_ORGANIZATION_REQUIRED", "SKILL_EDITOR_ACCESS_REQUIRED", "SECRET_ADMIN_ACCESS_REQUIRED", "WORKSPACE_RESOURCE_LIMIT_REACHED", "PUBLIC_SHARING_NOT_ALLOWED", "CREDENTIAL_ADMIN_ACCESS_REQUIRED", "MCP_SERVER_URL_NOT_ALLOWED", "WORKSPACE_PLAN_CAPABILITY_REQUIRED", "CHAT_AUTH_MODE_NOT_PERMITTED", "CONNECTOR_MANAGED_RESOURCE_READ_ONLY", "PERMISSION_GROUP_CAPABILITY_BLOCKED", "INTEGRATION_NOT_ALLOWED", "INSUFFICIENT_SCOPE", "SCIM_MANAGED_MEMBERSHIP" ], "title": "Forbidden detail code", "description": "Stable cause code for an actionable `403` response." } }, "required": [ "code" ], "additionalProperties": { "description": "Additional context for this refusal." }, "title": "Actionable forbidden details", "description": "Machine-readable cause and optional context for an actionable `403` response." }, { "description": "Other structured context defined by the specific error." } ] } }, "required": [ "code", "message" ], "additionalProperties": false, "description": "Canonical error details." } }, "required": [ "error" ], "additionalProperties": false, "title": "v2 error response", "description": "Canonical error envelope returned by the public v2 API.", "examples": [ { "error": { "code": "BAD_REQUEST", "message": "The request is invalid." } } ] }, "example": { "error": { "code": "BAD_REQUEST", "message": "Invalid request" } } } } } ``` ### 401 ```json { "description": "The API credential is missing or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable machine-readable error code." }, "message": { "type": "string", "description": "Human-readable explanation of the error." }, "details": { "description": "Structured error context whose keys depend on the error. Actionable `403` responses use the `V2ActionableForbiddenDetails` shape; validation failures may return issue arrays instead.", "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "INSUFFICIENT_WORKSPACE_ROLE", "PERSONAL_API_KEYS_DISABLED", "WORKSPACE_KEY_OPERATION_NOT_PERMITTED", "PRINCIPAL_KIND_NOT_PERMITTED", "ORGANIZATION_MEMBERSHIP_REQUIRED", "ORGANIZATION_ADMIN_REQUIRED", "ENTERPRISE_PLAN_REQUIRED", "SSO_DISABLED", "SSO_DOMAIN_NOT_VERIFIED", "SSO_PROVIDER_LIMIT_REACHED", "ORGANIZATION_PLAN_REQUIRED", "AUDIT_LOGS_DISABLED", "ACCESS_REQUESTS_DISABLED", "ACCESS_REQUEST_ORGANIZATION_REQUIRED", "SKILL_EDITOR_ACCESS_REQUIRED", "SECRET_ADMIN_ACCESS_REQUIRED", "WORKSPACE_RESOURCE_LIMIT_REACHED", "PUBLIC_SHARING_NOT_ALLOWED", "CREDENTIAL_ADMIN_ACCESS_REQUIRED", "MCP_SERVER_URL_NOT_ALLOWED", "WORKSPACE_PLAN_CAPABILITY_REQUIRED", "CHAT_AUTH_MODE_NOT_PERMITTED", "CONNECTOR_MANAGED_RESOURCE_READ_ONLY", "PERMISSION_GROUP_CAPABILITY_BLOCKED", "INTEGRATION_NOT_ALLOWED", "INSUFFICIENT_SCOPE", "SCIM_MANAGED_MEMBERSHIP" ], "title": "Forbidden detail code", "description": "Stable cause code for an actionable `403` response." } }, "required": [ "code" ], "additionalProperties": { "description": "Additional context for this refusal." }, "title": "Actionable forbidden details", "description": "Machine-readable cause and optional context for an actionable `403` response." }, { "description": "Other structured context defined by the specific error." } ] } }, "required": [ "code", "message" ], "additionalProperties": false, "description": "Canonical error details." } }, "required": [ "error" ], "additionalProperties": false, "title": "v2 error response", "description": "Canonical error envelope returned by the public v2 API.", "examples": [ { "error": { "code": "BAD_REQUEST", "message": "The request is invalid." } } ] }, "example": { "error": { "code": "UNAUTHORIZED", "message": "Authentication required" } } } } } ``` ### 403 ```json { "description": "The caller lacks the rights this operation requires. When the cause is one a caller can act on, `error.details.code` names it. A resource in a workspace the caller cannot reach at all answers `404` instead, so absence and denial are indistinguishable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable machine-readable error code." }, "message": { "type": "string", "description": "Human-readable explanation of the error." }, "details": { "description": "Structured error context whose keys depend on the error. Actionable `403` responses use the `V2ActionableForbiddenDetails` shape; validation failures may return issue arrays instead.", "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "INSUFFICIENT_WORKSPACE_ROLE", "PERSONAL_API_KEYS_DISABLED", "WORKSPACE_KEY_OPERATION_NOT_PERMITTED", "PRINCIPAL_KIND_NOT_PERMITTED", "ORGANIZATION_MEMBERSHIP_REQUIRED", "ORGANIZATION_ADMIN_REQUIRED", "ENTERPRISE_PLAN_REQUIRED", "SSO_DISABLED", "SSO_DOMAIN_NOT_VERIFIED", "SSO_PROVIDER_LIMIT_REACHED", "ORGANIZATION_PLAN_REQUIRED", "AUDIT_LOGS_DISABLED", "ACCESS_REQUESTS_DISABLED", "ACCESS_REQUEST_ORGANIZATION_REQUIRED", "SKILL_EDITOR_ACCESS_REQUIRED", "SECRET_ADMIN_ACCESS_REQUIRED", "WORKSPACE_RESOURCE_LIMIT_REACHED", "PUBLIC_SHARING_NOT_ALLOWED", "CREDENTIAL_ADMIN_ACCESS_REQUIRED", "MCP_SERVER_URL_NOT_ALLOWED", "WORKSPACE_PLAN_CAPABILITY_REQUIRED", "CHAT_AUTH_MODE_NOT_PERMITTED", "CONNECTOR_MANAGED_RESOURCE_READ_ONLY", "PERMISSION_GROUP_CAPABILITY_BLOCKED", "INTEGRATION_NOT_ALLOWED", "INSUFFICIENT_SCOPE", "SCIM_MANAGED_MEMBERSHIP" ], "title": "Forbidden detail code", "description": "Stable cause code for an actionable `403` response." } }, "required": [ "code" ], "additionalProperties": { "description": "Additional context for this refusal." }, "title": "Actionable forbidden details", "description": "Machine-readable cause and optional context for an actionable `403` response." }, { "description": "Other structured context defined by the specific error." } ] } }, "required": [ "code", "message" ], "additionalProperties": false, "description": "Canonical error details." } }, "required": [ "error" ], "additionalProperties": false, "title": "v2 error response", "description": "Canonical error envelope returned by the public v2 API.", "examples": [ { "error": { "code": "BAD_REQUEST", "message": "The request is invalid." } } ] }, "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient workspace permissions", "details": { "code": "INSUFFICIENT_WORKSPACE_ROLE" } } } } } } ``` ### 404 ```json { "description": "The requested resource was not found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable machine-readable error code." }, "message": { "type": "string", "description": "Human-readable explanation of the error." }, "details": { "description": "Structured error context whose keys depend on the error. Actionable `403` responses use the `V2ActionableForbiddenDetails` shape; validation failures may return issue arrays instead.", "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "INSUFFICIENT_WORKSPACE_ROLE", "PERSONAL_API_KEYS_DISABLED", "WORKSPACE_KEY_OPERATION_NOT_PERMITTED", "PRINCIPAL_KIND_NOT_PERMITTED", "ORGANIZATION_MEMBERSHIP_REQUIRED", "ORGANIZATION_ADMIN_REQUIRED", "ENTERPRISE_PLAN_REQUIRED", "SSO_DISABLED", "SSO_DOMAIN_NOT_VERIFIED", "SSO_PROVIDER_LIMIT_REACHED", "ORGANIZATION_PLAN_REQUIRED", "AUDIT_LOGS_DISABLED", "ACCESS_REQUESTS_DISABLED", "ACCESS_REQUEST_ORGANIZATION_REQUIRED", "SKILL_EDITOR_ACCESS_REQUIRED", "SECRET_ADMIN_ACCESS_REQUIRED", "WORKSPACE_RESOURCE_LIMIT_REACHED", "PUBLIC_SHARING_NOT_ALLOWED", "CREDENTIAL_ADMIN_ACCESS_REQUIRED", "MCP_SERVER_URL_NOT_ALLOWED", "WORKSPACE_PLAN_CAPABILITY_REQUIRED", "CHAT_AUTH_MODE_NOT_PERMITTED", "CONNECTOR_MANAGED_RESOURCE_READ_ONLY", "PERMISSION_GROUP_CAPABILITY_BLOCKED", "INTEGRATION_NOT_ALLOWED", "INSUFFICIENT_SCOPE", "SCIM_MANAGED_MEMBERSHIP" ], "title": "Forbidden detail code", "description": "Stable cause code for an actionable `403` response." } }, "required": [ "code" ], "additionalProperties": { "description": "Additional context for this refusal." }, "title": "Actionable forbidden details", "description": "Machine-readable cause and optional context for an actionable `403` response." }, { "description": "Other structured context defined by the specific error." } ] } }, "required": [ "code", "message" ], "additionalProperties": false, "description": "Canonical error details." } }, "required": [ "error" ], "additionalProperties": false, "title": "v2 error response", "description": "Canonical error envelope returned by the public v2 API.", "examples": [ { "error": { "code": "BAD_REQUEST", "message": "The request is invalid." } } ] }, "example": { "error": { "code": "NOT_FOUND", "message": "Not found" } } } } } ``` ### 409 ```json { "description": "The request conflicts with current resource state.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable machine-readable error code." }, "message": { "type": "string", "description": "Human-readable explanation of the error." }, "details": { "description": "Structured error context whose keys depend on the error. Actionable `403` responses use the `V2ActionableForbiddenDetails` shape; validation failures may return issue arrays instead.", "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "INSUFFICIENT_WORKSPACE_ROLE", "PERSONAL_API_KEYS_DISABLED", "WORKSPACE_KEY_OPERATION_NOT_PERMITTED", "PRINCIPAL_KIND_NOT_PERMITTED", "ORGANIZATION_MEMBERSHIP_REQUIRED", "ORGANIZATION_ADMIN_REQUIRED", "ENTERPRISE_PLAN_REQUIRED", "SSO_DISABLED", "SSO_DOMAIN_NOT_VERIFIED", "SSO_PROVIDER_LIMIT_REACHED", "ORGANIZATION_PLAN_REQUIRED", "AUDIT_LOGS_DISABLED", "ACCESS_REQUESTS_DISABLED", "ACCESS_REQUEST_ORGANIZATION_REQUIRED", "SKILL_EDITOR_ACCESS_REQUIRED", "SECRET_ADMIN_ACCESS_REQUIRED", "WORKSPACE_RESOURCE_LIMIT_REACHED", "PUBLIC_SHARING_NOT_ALLOWED", "CREDENTIAL_ADMIN_ACCESS_REQUIRED", "MCP_SERVER_URL_NOT_ALLOWED", "WORKSPACE_PLAN_CAPABILITY_REQUIRED", "CHAT_AUTH_MODE_NOT_PERMITTED", "CONNECTOR_MANAGED_RESOURCE_READ_ONLY", "PERMISSION_GROUP_CAPABILITY_BLOCKED", "INTEGRATION_NOT_ALLOWED", "INSUFFICIENT_SCOPE", "SCIM_MANAGED_MEMBERSHIP" ], "title": "Forbidden detail code", "description": "Stable cause code for an actionable `403` response." } }, "required": [ "code" ], "additionalProperties": { "description": "Additional context for this refusal." }, "title": "Actionable forbidden details", "description": "Machine-readable cause and optional context for an actionable `403` response." }, { "description": "Other structured context defined by the specific error." } ] } }, "required": [ "code", "message" ], "additionalProperties": false, "description": "Canonical error details." } }, "required": [ "error" ], "additionalProperties": false, "title": "v2 error response", "description": "Canonical error envelope returned by the public v2 API.", "examples": [ { "error": { "code": "BAD_REQUEST", "message": "The request is invalid." } } ] }, "example": { "error": { "code": "CONFLICT", "message": "The request conflicts with current resource state" } } } } } ``` ### 413 ```json { "description": "The request, or a resource collection it must materialize, exceeds the allowed size: an oversized request body, a generated artifact past the download ceiling, or a workspace folder tree too large to load in full.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable machine-readable error code." }, "message": { "type": "string", "description": "Human-readable explanation of the error." }, "details": { "description": "Structured error context whose keys depend on the error. Actionable `403` responses use the `V2ActionableForbiddenDetails` shape; validation failures may return issue arrays instead.", "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "INSUFFICIENT_WORKSPACE_ROLE", "PERSONAL_API_KEYS_DISABLED", "WORKSPACE_KEY_OPERATION_NOT_PERMITTED", "PRINCIPAL_KIND_NOT_PERMITTED", "ORGANIZATION_MEMBERSHIP_REQUIRED", "ORGANIZATION_ADMIN_REQUIRED", "ENTERPRISE_PLAN_REQUIRED", "SSO_DISABLED", "SSO_DOMAIN_NOT_VERIFIED", "SSO_PROVIDER_LIMIT_REACHED", "ORGANIZATION_PLAN_REQUIRED", "AUDIT_LOGS_DISABLED", "ACCESS_REQUESTS_DISABLED", "ACCESS_REQUEST_ORGANIZATION_REQUIRED", "SKILL_EDITOR_ACCESS_REQUIRED", "SECRET_ADMIN_ACCESS_REQUIRED", "WORKSPACE_RESOURCE_LIMIT_REACHED", "PUBLIC_SHARING_NOT_ALLOWED", "CREDENTIAL_ADMIN_ACCESS_REQUIRED", "MCP_SERVER_URL_NOT_ALLOWED", "WORKSPACE_PLAN_CAPABILITY_REQUIRED", "CHAT_AUTH_MODE_NOT_PERMITTED", "CONNECTOR_MANAGED_RESOURCE_READ_ONLY", "PERMISSION_GROUP_CAPABILITY_BLOCKED", "INTEGRATION_NOT_ALLOWED", "INSUFFICIENT_SCOPE", "SCIM_MANAGED_MEMBERSHIP" ], "title": "Forbidden detail code", "description": "Stable cause code for an actionable `403` response." } }, "required": [ "code" ], "additionalProperties": { "description": "Additional context for this refusal." }, "title": "Actionable forbidden details", "description": "Machine-readable cause and optional context for an actionable `403` response." }, { "description": "Other structured context defined by the specific error." } ] } }, "required": [ "code", "message" ], "additionalProperties": false, "description": "Canonical error details." } }, "required": [ "error" ], "additionalProperties": false, "title": "v2 error response", "description": "Canonical error envelope returned by the public v2 API.", "examples": [ { "error": { "code": "BAD_REQUEST", "message": "The request is invalid." } } ] }, "example": { "error": { "code": "PAYLOAD_TOO_LARGE", "message": "Request body is too large" } } } } } ``` ### 415 ```json { "description": "The request uses an unsupported media type.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable machine-readable error code." }, "message": { "type": "string", "description": "Human-readable explanation of the error." }, "details": { "description": "Structured error context whose keys depend on the error. Actionable `403` responses use the `V2ActionableForbiddenDetails` shape; validation failures may return issue arrays instead.", "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "INSUFFICIENT_WORKSPACE_ROLE", "PERSONAL_API_KEYS_DISABLED", "WORKSPACE_KEY_OPERATION_NOT_PERMITTED", "PRINCIPAL_KIND_NOT_PERMITTED", "ORGANIZATION_MEMBERSHIP_REQUIRED", "ORGANIZATION_ADMIN_REQUIRED", "ENTERPRISE_PLAN_REQUIRED", "SSO_DISABLED", "SSO_DOMAIN_NOT_VERIFIED", "SSO_PROVIDER_LIMIT_REACHED", "ORGANIZATION_PLAN_REQUIRED", "AUDIT_LOGS_DISABLED", "ACCESS_REQUESTS_DISABLED", "ACCESS_REQUEST_ORGANIZATION_REQUIRED", "SKILL_EDITOR_ACCESS_REQUIRED", "SECRET_ADMIN_ACCESS_REQUIRED", "WORKSPACE_RESOURCE_LIMIT_REACHED", "PUBLIC_SHARING_NOT_ALLOWED", "CREDENTIAL_ADMIN_ACCESS_REQUIRED", "MCP_SERVER_URL_NOT_ALLOWED", "WORKSPACE_PLAN_CAPABILITY_REQUIRED", "CHAT_AUTH_MODE_NOT_PERMITTED", "CONNECTOR_MANAGED_RESOURCE_READ_ONLY", "PERMISSION_GROUP_CAPABILITY_BLOCKED", "INTEGRATION_NOT_ALLOWED", "INSUFFICIENT_SCOPE", "SCIM_MANAGED_MEMBERSHIP" ], "title": "Forbidden detail code", "description": "Stable cause code for an actionable `403` response." } }, "required": [ "code" ], "additionalProperties": { "description": "Additional context for this refusal." }, "title": "Actionable forbidden details", "description": "Machine-readable cause and optional context for an actionable `403` response." }, { "description": "Other structured context defined by the specific error." } ] } }, "required": [ "code", "message" ], "additionalProperties": false, "description": "Canonical error details." } }, "required": [ "error" ], "additionalProperties": false, "title": "v2 error response", "description": "Canonical error envelope returned by the public v2 API.", "examples": [ { "error": { "code": "BAD_REQUEST", "message": "The request is invalid." } } ] }, "example": { "error": { "code": "UNSUPPORTED_MEDIA_TYPE", "message": "Request body must be sent as application/json" } } } } } ``` ### 423 ```json { "description": "The resource is temporarily locked or unavailable; retry the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable machine-readable error code." }, "message": { "type": "string", "description": "Human-readable explanation of the error." }, "details": { "description": "Structured error context whose keys depend on the error. Actionable `403` responses use the `V2ActionableForbiddenDetails` shape; validation failures may return issue arrays instead.", "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "INSUFFICIENT_WORKSPACE_ROLE", "PERSONAL_API_KEYS_DISABLED", "WORKSPACE_KEY_OPERATION_NOT_PERMITTED", "PRINCIPAL_KIND_NOT_PERMITTED", "ORGANIZATION_MEMBERSHIP_REQUIRED", "ORGANIZATION_ADMIN_REQUIRED", "ENTERPRISE_PLAN_REQUIRED", "SSO_DISABLED", "SSO_DOMAIN_NOT_VERIFIED", "SSO_PROVIDER_LIMIT_REACHED", "ORGANIZATION_PLAN_REQUIRED", "AUDIT_LOGS_DISABLED", "ACCESS_REQUESTS_DISABLED", "ACCESS_REQUEST_ORGANIZATION_REQUIRED", "SKILL_EDITOR_ACCESS_REQUIRED", "SECRET_ADMIN_ACCESS_REQUIRED", "WORKSPACE_RESOURCE_LIMIT_REACHED", "PUBLIC_SHARING_NOT_ALLOWED", "CREDENTIAL_ADMIN_ACCESS_REQUIRED", "MCP_SERVER_URL_NOT_ALLOWED", "WORKSPACE_PLAN_CAPABILITY_REQUIRED", "CHAT_AUTH_MODE_NOT_PERMITTED", "CONNECTOR_MANAGED_RESOURCE_READ_ONLY", "PERMISSION_GROUP_CAPABILITY_BLOCKED", "INTEGRATION_NOT_ALLOWED", "INSUFFICIENT_SCOPE", "SCIM_MANAGED_MEMBERSHIP" ], "title": "Forbidden detail code", "description": "Stable cause code for an actionable `403` response." } }, "required": [ "code" ], "additionalProperties": { "description": "Additional context for this refusal." }, "title": "Actionable forbidden details", "description": "Machine-readable cause and optional context for an actionable `403` response." }, { "description": "Other structured context defined by the specific error." } ] } }, "required": [ "code", "message" ], "additionalProperties": false, "description": "Canonical error details." } }, "required": [ "error" ], "additionalProperties": false, "title": "v2 error response", "description": "Canonical error envelope returned by the public v2 API.", "examples": [ { "error": { "code": "BAD_REQUEST", "message": "The request is invalid." } } ] }, "example": { "error": { "code": "LOCKED", "message": "Workflow is locked" } } } } } ``` ### 429 ```json { "description": "The caller exceeded the request rate limit.", "headers": { "Retry-After": { "description": "Seconds to wait before retrying, sent on `429` and `503`. Add jitter rather than retrying at exactly this offset.", "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "title": "Retry after", "description": "Seconds to wait before retrying, sent on `429` and `503`. Add jitter rather than retrying at exactly this offset." } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable machine-readable error code." }, "message": { "type": "string", "description": "Human-readable explanation of the error." }, "details": { "description": "Structured error context whose keys depend on the error. Actionable `403` responses use the `V2ActionableForbiddenDetails` shape; validation failures may return issue arrays instead.", "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "INSUFFICIENT_WORKSPACE_ROLE", "PERSONAL_API_KEYS_DISABLED", "WORKSPACE_KEY_OPERATION_NOT_PERMITTED", "PRINCIPAL_KIND_NOT_PERMITTED", "ORGANIZATION_MEMBERSHIP_REQUIRED", "ORGANIZATION_ADMIN_REQUIRED", "ENTERPRISE_PLAN_REQUIRED", "SSO_DISABLED", "SSO_DOMAIN_NOT_VERIFIED", "SSO_PROVIDER_LIMIT_REACHED", "ORGANIZATION_PLAN_REQUIRED", "AUDIT_LOGS_DISABLED", "ACCESS_REQUESTS_DISABLED", "ACCESS_REQUEST_ORGANIZATION_REQUIRED", "SKILL_EDITOR_ACCESS_REQUIRED", "SECRET_ADMIN_ACCESS_REQUIRED", "WORKSPACE_RESOURCE_LIMIT_REACHED", "PUBLIC_SHARING_NOT_ALLOWED", "CREDENTIAL_ADMIN_ACCESS_REQUIRED", "MCP_SERVER_URL_NOT_ALLOWED", "WORKSPACE_PLAN_CAPABILITY_REQUIRED", "CHAT_AUTH_MODE_NOT_PERMITTED", "CONNECTOR_MANAGED_RESOURCE_READ_ONLY", "PERMISSION_GROUP_CAPABILITY_BLOCKED", "INTEGRATION_NOT_ALLOWED", "INSUFFICIENT_SCOPE", "SCIM_MANAGED_MEMBERSHIP" ], "title": "Forbidden detail code", "description": "Stable cause code for an actionable `403` response." } }, "required": [ "code" ], "additionalProperties": { "description": "Additional context for this refusal." }, "title": "Actionable forbidden details", "description": "Machine-readable cause and optional context for an actionable `403` response." }, { "description": "Other structured context defined by the specific error." } ] } }, "required": [ "code", "message" ], "additionalProperties": false, "description": "Canonical error details." } }, "required": [ "error" ], "additionalProperties": false, "title": "v2 error response", "description": "Canonical error envelope returned by the public v2 API.", "examples": [ { "error": { "code": "BAD_REQUEST", "message": "The request is invalid." } } ] }, "example": { "error": { "code": "RATE_LIMITED", "message": "API rate limit exceeded", "details": { "retryAfter": "2026-01-01T00:00:30.000Z" } } } } } } ``` ### 500 ```json { "description": "An unexpected server error occurred.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable machine-readable error code." }, "message": { "type": "string", "description": "Human-readable explanation of the error." }, "details": { "description": "Structured error context whose keys depend on the error. Actionable `403` responses use the `V2ActionableForbiddenDetails` shape; validation failures may return issue arrays instead.", "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "INSUFFICIENT_WORKSPACE_ROLE", "PERSONAL_API_KEYS_DISABLED", "WORKSPACE_KEY_OPERATION_NOT_PERMITTED", "PRINCIPAL_KIND_NOT_PERMITTED", "ORGANIZATION_MEMBERSHIP_REQUIRED", "ORGANIZATION_ADMIN_REQUIRED", "ENTERPRISE_PLAN_REQUIRED", "SSO_DISABLED", "SSO_DOMAIN_NOT_VERIFIED", "SSO_PROVIDER_LIMIT_REACHED", "ORGANIZATION_PLAN_REQUIRED", "AUDIT_LOGS_DISABLED", "ACCESS_REQUESTS_DISABLED", "ACCESS_REQUEST_ORGANIZATION_REQUIRED", "SKILL_EDITOR_ACCESS_REQUIRED", "SECRET_ADMIN_ACCESS_REQUIRED", "WORKSPACE_RESOURCE_LIMIT_REACHED", "PUBLIC_SHARING_NOT_ALLOWED", "CREDENTIAL_ADMIN_ACCESS_REQUIRED", "MCP_SERVER_URL_NOT_ALLOWED", "WORKSPACE_PLAN_CAPABILITY_REQUIRED", "CHAT_AUTH_MODE_NOT_PERMITTED", "CONNECTOR_MANAGED_RESOURCE_READ_ONLY", "PERMISSION_GROUP_CAPABILITY_BLOCKED", "INTEGRATION_NOT_ALLOWED", "INSUFFICIENT_SCOPE", "SCIM_MANAGED_MEMBERSHIP" ], "title": "Forbidden detail code", "description": "Stable cause code for an actionable `403` response." } }, "required": [ "code" ], "additionalProperties": { "description": "Additional context for this refusal." }, "title": "Actionable forbidden details", "description": "Machine-readable cause and optional context for an actionable `403` response." }, { "description": "Other structured context defined by the specific error." } ] } }, "required": [ "code", "message" ], "additionalProperties": false, "description": "Canonical error details." } }, "required": [ "error" ], "additionalProperties": false, "title": "v2 error response", "description": "Canonical error envelope returned by the public v2 API.", "examples": [ { "error": { "code": "BAD_REQUEST", "message": "The request is invalid." } } ] }, "example": { "error": { "code": "INTERNAL_ERROR", "message": "Internal server error" } } } } } ``` ### 503 ```json { "description": "A required service is temporarily unavailable. When present, `Retry-After` gives the minimum seconds to wait; add jitter before retrying. Check operation-specific guidance before repeating a change after an uncertain response.", "headers": { "Retry-After": { "description": "Seconds to wait before retrying, sent on `429` and `503`. Add jitter rather than retrying at exactly this offset.", "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "title": "Retry after", "description": "Seconds to wait before retrying, sent on `429` and `503`. Add jitter rather than retrying at exactly this offset." } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable machine-readable error code." }, "message": { "type": "string", "description": "Human-readable explanation of the error." }, "details": { "description": "Structured error context whose keys depend on the error. Actionable `403` responses use the `V2ActionableForbiddenDetails` shape; validation failures may return issue arrays instead.", "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "INSUFFICIENT_WORKSPACE_ROLE", "PERSONAL_API_KEYS_DISABLED", "WORKSPACE_KEY_OPERATION_NOT_PERMITTED", "PRINCIPAL_KIND_NOT_PERMITTED", "ORGANIZATION_MEMBERSHIP_REQUIRED", "ORGANIZATION_ADMIN_REQUIRED", "ENTERPRISE_PLAN_REQUIRED", "SSO_DISABLED", "SSO_DOMAIN_NOT_VERIFIED", "SSO_PROVIDER_LIMIT_REACHED", "ORGANIZATION_PLAN_REQUIRED", "AUDIT_LOGS_DISABLED", "ACCESS_REQUESTS_DISABLED", "ACCESS_REQUEST_ORGANIZATION_REQUIRED", "SKILL_EDITOR_ACCESS_REQUIRED", "SECRET_ADMIN_ACCESS_REQUIRED", "WORKSPACE_RESOURCE_LIMIT_REACHED", "PUBLIC_SHARING_NOT_ALLOWED", "CREDENTIAL_ADMIN_ACCESS_REQUIRED", "MCP_SERVER_URL_NOT_ALLOWED", "WORKSPACE_PLAN_CAPABILITY_REQUIRED", "CHAT_AUTH_MODE_NOT_PERMITTED", "CONNECTOR_MANAGED_RESOURCE_READ_ONLY", "PERMISSION_GROUP_CAPABILITY_BLOCKED", "INTEGRATION_NOT_ALLOWED", "INSUFFICIENT_SCOPE", "SCIM_MANAGED_MEMBERSHIP" ], "title": "Forbidden detail code", "description": "Stable cause code for an actionable `403` response." } }, "required": [ "code" ], "additionalProperties": { "description": "Additional context for this refusal." }, "title": "Actionable forbidden details", "description": "Machine-readable cause and optional context for an actionable `403` response." }, { "description": "Other structured context defined by the specific error." } ] } }, "required": [ "code", "message" ], "additionalProperties": false, "description": "Canonical error details." } }, "required": [ "error" ], "additionalProperties": false, "title": "v2 error response", "description": "Canonical error envelope returned by the public v2 API.", "examples": [ { "error": { "code": "BAD_REQUEST", "message": "The request is invalid." } } ] }, "example": { "error": { "code": "SERVICE_UNAVAILABLE", "message": "Service temporarily unavailable" } } } } } ``` ## Referenced schemas The following definitions preserve recursive references and composition exactly. ```json { "#/components/schemas/ReplaceWorkflowStateRequest": { "type": "object", "properties": { "blocks": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/WorkflowBlockInput" }, "description": "Blocks keyed by block id." }, "edges": { "maxItems": 10000, "type": "array", "items": { "$ref": "#/components/schemas/WorkflowEdgeInput" }, "description": "Directed connections between blocks." }, "loops": { "description": "Ignored on write: loop containers are recomputed from `blocks`.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/WorkflowLoopInput" } }, "parallels": { "description": "Ignored on write: parallel containers are recomputed from `blocks`.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/WorkflowParallelInput" } }, "variables": { "description": "Replacement variable set. Omit to leave the stored variables untouched.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/WorkflowVariableInput" } } }, "required": [ "blocks", "edges" ], "additionalProperties": false, "title": "Replace workflow state request", "description": "A complete replacement draft graph for a workflow.", "examples": [ { "blocks": {}, "edges": [] } ] }, "#/components/schemas/WorkflowBlockInput": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Block identifier, unique within the workflow." }, "type": { "type": "string", "minLength": 1, "description": "Registered block type." }, "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Block display name; must be unique within the workflow." }, "position": { "type": "object", "properties": { "x": { "type": "number", "description": "Canvas x coordinate." }, "y": { "type": "number", "description": "Canvas y coordinate." } }, "required": [ "x", "y" ], "description": "Canvas coordinates of a block." }, "subBlocks": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Sub-block identifier." }, "type": { "type": "string", "minLength": 1, "description": "Sub-block input type." }, "value": { "description": "Configured value; shape depends on the sub-block type." } }, "required": [ "id", "type", "value" ], "description": "One configurable input on a block." }, "description": "Configured inputs keyed by sub-block id." }, "outputs": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "Declared shape of one output; depends on the block type." }, "description": "Declared output shape keyed by output name." }, "enabled": { "type": "boolean", "description": "Whether the block runs." }, "horizontalHandles": { "description": "Whether edge handles render horizontally.", "type": "boolean" }, "height": { "description": "Rendered block height.", "type": "number" }, "advancedMode": { "description": "Whether the block is edited in advanced mode.", "type": "boolean" }, "errorEnabled": { "description": "Whether the block exposes an error branch.", "type": "boolean" }, "retry": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether the block retries on failure." }, "maxTries": { "type": "integer", "minimum": 2, "maximum": 5, "description": "Total attempts, including the first." }, "waitBetweenTriesMs": { "type": "integer", "minimum": 0, "maximum": 5000, "description": "Delay between attempts, in milliseconds." } }, "required": [ "enabled", "maxTries", "waitBetweenTriesMs" ], "description": "Per-block retry configuration." }, "triggerMode": { "description": "Whether the block acts as the workflow trigger.", "type": "boolean" }, "data": { "type": "object", "properties": { "parentId": { "description": "Identifier of the containing loop or parallel.", "type": "string" }, "extent": { "description": "Constrains the block to its parent bounds.", "type": "string", "const": "parent" }, "width": { "description": "Rendered container width.", "type": "number" }, "height": { "description": "Rendered container height.", "type": "number" }, "collection": { "description": "Items a forEach loop or collection parallel iterates." }, "count": { "description": "Iteration count for a `for` loop or count parallel.", "type": "number" }, "loopType": { "description": "Loop container kind.", "type": "string", "enum": [ "for", "forEach", "while", "doWhile" ] }, "whileCondition": { "description": "Condition expression for a `while` loop.", "type": "string" }, "doWhileCondition": { "description": "Condition expression for a `doWhile` loop.", "type": "string" }, "parallelType": { "description": "Parallel container kind.", "type": "string", "enum": [ "collection", "count" ] }, "batchSize": { "description": "Maximum concurrent branches of a parallel.", "type": "number" }, "type": { "description": "Container subtype.", "type": "string" }, "canonicalModes": { "description": "Per-field editing mode, keyed by canonical parameter id.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string", "enum": [ "basic", "advanced" ] } } }, "description": "Container and layout metadata carried by a block." }, "locked": { "description": "Whether the block is locked against edits.", "type": "boolean" } }, "required": [ "id", "type", "name", "position", "subBlocks", "outputs", "enabled" ], "title": "Workflow block", "description": "One node of a workflow graph and its configuration." }, "#/components/schemas/WorkflowEdgeInput": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Edge identifier, unique within the workflow." }, "source": { "type": "string", "minLength": 1, "description": "Source block id." }, "target": { "type": "string", "minLength": 1, "description": "Target block id." }, "sourceHandle": { "description": "Source port, or null for the block default.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "targetHandle": { "description": "Target port, or null for the block default.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "description": "Edge renderer type.", "type": "string" } }, "required": [ "id", "source", "target" ], "title": "Workflow edge", "description": "A directed connection between two blocks." }, "#/components/schemas/WorkflowLoopInput": { "type": "object", "properties": { "id": { "type": "string", "description": "Loop container identifier; equal to the loop block id." }, "nodes": { "type": "array", "items": { "type": "string" }, "description": "Block ids inside the loop." }, "iterations": { "type": "number", "description": "Resolved iteration count." }, "loopType": { "type": "string", "enum": [ "for", "forEach", "while", "doWhile" ], "description": "Loop kind." }, "forEachItems": { "description": "Items a forEach loop iterates, or the expression producing them.", "anyOf": [ { "type": "array", "items": { "description": "One item the loop iterates." } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "One item the loop iterates." } }, { "type": "string" } ] }, "whileCondition": { "description": "Condition expression for a `while` loop.", "type": "string" }, "doWhileCondition": { "description": "Condition expression for a `doWhile` loop.", "type": "string" }, "enabled": { "description": "Whether the loop runs.", "type": "boolean" }, "locked": { "description": "Whether the loop is locked against edits.", "type": "boolean" } }, "required": [ "id", "nodes", "iterations", "loopType" ], "title": "Workflow loop", "description": "A loop container derived from the workflow blocks." }, "#/components/schemas/WorkflowParallelInput": { "type": "object", "properties": { "id": { "type": "string", "description": "Parallel container identifier; equal to the parallel block id." }, "nodes": { "type": "array", "items": { "type": "string" }, "description": "Block ids inside the parallel." }, "distribution": { "description": "Items distributed across branches, or the expression producing them.", "anyOf": [ { "type": "array", "items": { "description": "One item distributed to a branch." } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "One item distributed to a branch." } }, { "type": "string" } ] }, "count": { "description": "Fixed branch count.", "type": "number" }, "parallelType": { "description": "Parallel kind.", "type": "string", "enum": [ "count", "collection" ] }, "batchSize": { "description": "Maximum concurrent branches.", "type": "number" }, "enabled": { "description": "Whether the parallel runs.", "type": "boolean" }, "locked": { "description": "Whether the parallel is locked against edits.", "type": "boolean" } }, "required": [ "id", "nodes" ], "title": "Workflow parallel", "description": "A parallel container derived from the workflow blocks." }, "#/components/schemas/WorkflowVariableInput": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Variable identifier." }, "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Variable name, referenced from block inputs." }, "type": { "type": "string", "enum": [ "string", "number", "boolean", "object", "array", "plain" ], "description": "Declared variable type." }, "value": { "description": "Variable value; free-form and validated per `type` at use time." } }, "required": [ "id", "name", "type", "value" ], "title": "Workflow variable", "description": "A workflow-scoped variable." }, "#/components/headers/X-RateLimit-Limit": { "description": "Maximum requests allowed in the current window.", "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "title": "Rate limit", "description": "Maximum requests allowed in the current window." } }, "#/components/headers/X-RateLimit-Remaining": { "description": "Requests remaining in the current window.", "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "title": "Rate limit remaining", "description": "Requests remaining in the current window." } }, "#/components/headers/X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the current rate-limit window resets.", "schema": { "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))$", "title": "Rate limit reset", "description": "ISO 8601 timestamp when the current rate-limit window resets." } }, "#/components/schemas/ReplaceWorkflowStateResponse": { "type": "object", "properties": { "data": { "description": "Response data.", "$ref": "#/components/schemas/ReplaceWorkflowStateResult" } }, "required": [ "data" ], "additionalProperties": false, "title": "Replace workflow state response", "description": "Outcome of replacing a workflow draft graph.", "examples": [ { "data": { "id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36", "warnings": [], "needsRedeployment": true, "dryRun": false, "lint": { "sources": [], "sinks": [], "orphanBlocks": [], "emptyOutgoingPorts": [], "invalidBranchPorts": [], "invalidConnectionTargets": [], "fieldIssues": [], "unresolvedReferences": [], "tableFieldIssues": [], "manualRunIssue": null, "notes": [] } } } ] }, "#/components/schemas/ReplaceWorkflowStateResult": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the workflow whose draft graph was written." }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Non-fatal notes about blocks and edges that were normalized or dropped before persistence. Empty when there was nothing to report." }, "needsRedeployment": { "type": "boolean", "description": "Whether the live deployment differs from the draft. A graph write never changes what the deployed endpoint serves; deploy to publish it. On a dry run, this describes the state before the proposed write." }, "lint": { "$ref": "#/components/schemas/WorkflowLintReport" }, "dryRun": { "type": "boolean", "description": "Whether this request only validated. `true` means nothing was persisted; the findings describe what a committed write of the same body would produce." } }, "required": [ "id", "warnings", "needsRedeployment", "lint", "dryRun" ], "additionalProperties": false, "title": "Replace workflow state result", "description": "Response data." }, "#/components/schemas/WorkflowLintReport": { "type": "object", "properties": { "sources": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." } }, "required": [ "blockId", "blockName", "blockType" ], "additionalProperties": false }, "description": "Blocks with no incoming edge. A trigger block is naturally a source; anything else here is unreachable." }, "sinks": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." } }, "required": [ "blockId", "blockName", "blockType" ], "additionalProperties": false }, "description": "Blocks with no outgoing edge." }, "orphanBlocks": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." } }, "required": [ "blockId", "blockName", "blockType" ], "additionalProperties": false }, "description": "Blocks with neither an incoming nor an outgoing edge." }, "emptyOutgoingPorts": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." }, "handle": { "type": "string", "description": "Source handle with nothing connected to it." }, "label": { "type": "string", "description": "Human-readable name of the port." } }, "required": [ "blockId", "blockName", "blockType", "handle", "label" ], "additionalProperties": false }, "description": "Branch and container ports that lead nowhere." }, "invalidBranchPorts": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." }, "sourceHandle": { "type": "string", "description": "Source handle that does not match the block." }, "reason": { "type": "string", "description": "Why the handle is not valid for this block." } }, "required": [ "blockId", "blockName", "blockType", "sourceHandle", "reason" ], "additionalProperties": false }, "description": "Condition and router edges whose source handle names no real branch." }, "invalidConnectionTargets": { "type": "array", "items": { "type": "object", "properties": { "sourceBlockId": { "type": "string", "description": "Block the edge leaves." }, "sourceBlockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the source block." }, "sourceHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Handle the edge leaves from." }, "targetBlockId": { "type": "string", "description": "Block the edge points at." }, "reason": { "type": "string", "description": "Why the target is not a legal destination." } }, "required": [ "sourceBlockId", "sourceBlockName", "sourceHandle", "targetBlockId", "reason" ], "additionalProperties": false }, "description": "Edges pointing at a block that cannot legally receive them." }, "fieldIssues": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." }, "missingRequiredFields": { "type": "array", "items": { "type": "string" }, "description": "Required sub-block fields that resolve empty in the active mode." }, "inactiveModeValues": { "type": "array", "items": { "type": "object", "properties": { "canonicalId": { "type": "string", "description": "Canonical parameter the two sub-block modes share." }, "activeMemberId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sub-block the runtime reads, where the value should live." }, "inactiveMemberId": { "type": "string", "description": "Sub-block holding the stranded value, which the runtime ignores." }, "kind": { "type": "string", "enum": [ "credential", "resource", "other" ], "description": "What kind of value is stranded." } }, "required": [ "canonicalId", "activeMemberId", "inactiveMemberId", "kind" ], "additionalProperties": false }, "description": "Values stranded on the inactive member of a canonical pair." } }, "required": [ "blockId", "blockName", "blockType", "missingRequiredFields", "inactiveModeValues" ], "additionalProperties": false }, "description": "Per-block configuration problems. The most actionable part of the report for a headless graph builder: a block missing a required field will fail at run time." }, "unresolvedReferences": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." }, "field": { "type": "string", "description": "Sub-block field holding the reference." }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "The reference, or references, that did not resolve." }, "kind": { "type": "string", "enum": [ "credential", "resource", "custom-tool", "mcp-tool", "skill", "block-output" ], "description": "What kind of entity the reference was expected to name." }, "reason": { "type": "string", "description": "Why the reference does not resolve." } }, "required": [ "blockId", "blockName", "blockType", "field", "value", "kind", "reason" ], "additionalProperties": false }, "description": "Credential, resource, tool, and skill references that do not resolve; `block-output` references that will not work as written: a block that does not exist, or an output field the block does not have (reason `unknown-field`); and text outputs written unquoted in a JSON field (reason `unquoted-json-string`), which leave the field invalid JSON at run time unless the text is itself JSON. These values are still persisted; they are reported, not dropped." }, "tableFieldIssues": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block the finding is about." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the block, when it has one." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of the block, when it has one." }, "field": { "type": "string", "description": "The filter or sort field that names no column." }, "tableName": { "type": "string", "description": "Display name of the table the block is bound to." } }, "required": [ "blockId", "blockName", "blockType", "field", "tableName" ], "additionalProperties": false }, "description": "Table block `filter` and `order` fields checked against the bound table's live schema that name no column (nor the implicit `id`, `createdAt`, `updatedAt`). Such a run fails inside the block's error edge. A filter holding a `` reference, or one that is not JSON, is not checked." }, "manualRunIssue": { "anyOf": [ { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "no-trigger", "multiple-api-triggers", "trigger-not-connected" ], "description": "Why the run is refused." }, "message": { "type": "string", "description": "The error the manual run raises." }, "blockId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Trigger the run would start from, when the problem is that trigger." }, "blockName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of that trigger." }, "blockType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Registered type of that trigger." } }, "required": [ "reason", "message", "blockId", "blockName", "blockType" ], "additionalProperties": false }, { "type": "null" } ], "description": "Why a manual run from the editor's Run button would be refused before it starts: no enabled trigger it can start from, more than one API trigger, or a selected trigger with no outgoing connection. The API run endpoints do not apply these checks. `null` when no manual-run issue is reported: the run can begin, only a chat trigger can start the workflow, or the graph is empty (reported in `notes` instead)." }, "notes": { "type": "array", "items": { "type": "string" }, "description": "Advisory notes about the report itself." } }, "required": [ "sources", "sinks", "orphanBlocks", "emptyOutgoingPorts", "invalidBranchPorts", "invalidConnectionTargets", "fieldIssues", "unresolvedReferences", "tableFieldIssues", "manualRunIssue", "notes" ], "additionalProperties": false, "title": "Workflow lint report", "description": "Advisory findings about a saved graph. Findings never block a write or a deploy; they tell a caller what will misbehave at run time." }, "#/components/responses/BadRequest": { "description": "The request is invalid. This includes a query parameter sent with no value (`?limit=`, `?search=`), which is rejected rather than read as zero, empty, or the parameter default — omit the parameter instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2Error" }, "example": { "error": { "code": "BAD_REQUEST", "message": "Invalid request" } } } } }, "#/components/schemas/V2Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable machine-readable error code." }, "message": { "type": "string", "description": "Human-readable explanation of the error." }, "details": { "description": "Structured error context whose keys depend on the error. Actionable `403` responses use the `V2ActionableForbiddenDetails` shape; validation failures may return issue arrays instead.", "anyOf": [ { "$ref": "#/components/schemas/V2ActionableForbiddenDetails" }, { "description": "Other structured context defined by the specific error." } ] } }, "required": [ "code", "message" ], "additionalProperties": false, "description": "Canonical error details." } }, "required": [ "error" ], "additionalProperties": false, "title": "v2 error response", "description": "Canonical error envelope returned by the public v2 API.", "examples": [ { "error": { "code": "BAD_REQUEST", "message": "The request is invalid." } } ] }, "#/components/schemas/V2ActionableForbiddenDetails": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/V2ForbiddenDetailCode" } }, "required": [ "code" ], "additionalProperties": { "description": "Additional context for this refusal." }, "title": "Actionable forbidden details", "description": "Machine-readable cause and optional context for an actionable `403` response." }, "#/components/schemas/V2ForbiddenDetailCode": { "type": "string", "enum": [ "INSUFFICIENT_WORKSPACE_ROLE", "PERSONAL_API_KEYS_DISABLED", "WORKSPACE_KEY_OPERATION_NOT_PERMITTED", "PRINCIPAL_KIND_NOT_PERMITTED", "ORGANIZATION_MEMBERSHIP_REQUIRED", "ORGANIZATION_ADMIN_REQUIRED", "ENTERPRISE_PLAN_REQUIRED", "SSO_DISABLED", "SSO_DOMAIN_NOT_VERIFIED", "SSO_PROVIDER_LIMIT_REACHED", "ORGANIZATION_PLAN_REQUIRED", "AUDIT_LOGS_DISABLED", "ACCESS_REQUESTS_DISABLED", "ACCESS_REQUEST_ORGANIZATION_REQUIRED", "SKILL_EDITOR_ACCESS_REQUIRED", "SECRET_ADMIN_ACCESS_REQUIRED", "WORKSPACE_RESOURCE_LIMIT_REACHED", "PUBLIC_SHARING_NOT_ALLOWED", "CREDENTIAL_ADMIN_ACCESS_REQUIRED", "MCP_SERVER_URL_NOT_ALLOWED", "WORKSPACE_PLAN_CAPABILITY_REQUIRED", "CHAT_AUTH_MODE_NOT_PERMITTED", "CONNECTOR_MANAGED_RESOURCE_READ_ONLY", "PERMISSION_GROUP_CAPABILITY_BLOCKED", "INTEGRATION_NOT_ALLOWED", "INSUFFICIENT_SCOPE", "SCIM_MANAGED_MEMBERSHIP" ], "title": "Forbidden detail code", "description": "Stable cause code for an actionable `403` response." }, "#/components/responses/Unauthorized": { "description": "The API credential is missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2Error" }, "example": { "error": { "code": "UNAUTHORIZED", "message": "Authentication required" } } } } }, "#/components/responses/Forbidden": { "description": "The caller lacks the rights this operation requires. When the cause is one a caller can act on, `error.details.code` names it. A resource in a workspace the caller cannot reach at all answers `404` instead, so absence and denial are indistinguishable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2Error" }, "example": { "error": { "code": "FORBIDDEN", "message": "Insufficient workspace permissions", "details": { "code": "INSUFFICIENT_WORKSPACE_ROLE" } } } } } }, "#/components/responses/NotFound": { "description": "The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2Error" }, "example": { "error": { "code": "NOT_FOUND", "message": "Not found" } } } } }, "#/components/responses/Conflict": { "description": "The request conflicts with current resource state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2Error" }, "example": { "error": { "code": "CONFLICT", "message": "The request conflicts with current resource state" } } } } }, "#/components/responses/PayloadTooLarge": { "description": "The request, or a resource collection it must materialize, exceeds the allowed size: an oversized request body, a generated artifact past the download ceiling, or a workspace folder tree too large to load in full.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2Error" }, "example": { "error": { "code": "PAYLOAD_TOO_LARGE", "message": "Request body is too large" } } } } }, "#/components/responses/UnsupportedMediaType": { "description": "The request uses an unsupported media type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2Error" }, "example": { "error": { "code": "UNSUPPORTED_MEDIA_TYPE", "message": "Request body must be sent as application/json" } } } } }, "#/components/responses/Locked": { "description": "The resource is temporarily locked or unavailable; retry the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2Error" }, "example": { "error": { "code": "LOCKED", "message": "Workflow is locked" } } } } }, "#/components/responses/RateLimited": { "description": "The caller exceeded the request rate limit.", "headers": { "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2Error" }, "example": { "error": { "code": "RATE_LIMITED", "message": "API rate limit exceeded", "details": { "retryAfter": "2026-01-01T00:00:30.000Z" } } } } } }, "#/components/headers/Retry-After": { "description": "Seconds to wait before retrying, sent on `429` and `503`. Add jitter rather than retrying at exactly this offset.", "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "title": "Retry after", "description": "Seconds to wait before retrying, sent on `429` and `503`. Add jitter rather than retrying at exactly this offset." } }, "#/components/responses/InternalError": { "description": "An unexpected server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2Error" }, "example": { "error": { "code": "INTERNAL_ERROR", "message": "Internal server error" } } } } }, "#/components/responses/ServiceUnavailable": { "description": "A required service is temporarily unavailable. When present, `Retry-After` gives the minimum seconds to wait; add jitter before retrying. Check operation-specific guidance before repeating a change after an uncertain response.", "headers": { "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2Error" }, "example": { "error": { "code": "SERVICE_UNAVAILABLE", "message": "Service temporarily unavailable" } } } } } } ``` [Download OpenAPI specification](/openapi.json) Source: `openapi-v2-workflows.json`, operation `replaceWorkflowState`.