{

"openapi": "3.1.0",

"info": {

"title": "Sim API v2 — Workflows",

"description": "Version 2 of the Sim REST API for workflow management, deployment versions, execution, run lifecycle, folders, and portable import and export.",

"version": "2.0.0",

"contact": {

"name": "Sim Support",

"email": "help@sim.ai",

"url": "https://www.sim.ai"

},

"license": {

"name": "Apache 2.0",

"url": "https://www.apache.org/licenses/LICENSE-2.0.html"

}

},

"servers": [

{

"url": "https://www.sim.ai",

"description": "Production"

}

],

"tags": [

{

"name": "Workflows",

"description": "Manage and execute workflow definitions, folders, deployment versions, and portable imports and exports."

},

{

"name": "Workflow Runs",

"description": "Inspect, resume, and cancel workflow runs."

}

],

"security": [

{

"apiKey": []

}

],

"paths": {

"/api/v2/workflows": {

"get": {

"operationId": "listWorkflows",

"summary": "List Workflows",

"description": "List workflows in a workspace with lifecycle scope, folder and deployment filters, search, sorting, and opaque cursor pagination. `scope` defaults to `active`; pass `archived` to list workflows a `DELETE` archived. A workspace folder tree over 10,000 folders is a `413`.",

"tags": ["Workflows"],

"parameters": [

{

"name": "workspaceId",

"in": "query",

"required": true,

"description": "Workspace whose workflows should be listed.",

"schema": {

"type": "string",

"minLength": 1,

"maxLength": 128,

"description": "Workspace whose workflows should be listed."

}

},

{

"name": "scope",

"in": "query",

"required": false,

"description": "Which lifecycle set to list: `active` (default) for live workflows, `archived` for workflows a `DELETE` archived. The folder filter resolves against active folders only, so pairing it with `archived` returns an empty page when the containing folder was archived too.",

"schema": {

"default": "active",

"description": "Which lifecycle set to list: `active` (default) for live workflows, `archived` for workflows a `DELETE` archived. The folder filter resolves against active folders only, so pairing it with `archived` returns an empty page when the containing folder was archived too.",

"type": "string",

"enum": ["active", "archived"]

}

},

{

"name": "folderPath",

"in": "query",

"required": false,

"description": "Restrict results to workflows in this folder path. A path that names no folder narrows the result to nothing, so the response is an empty page rather than an error.",

"schema": {

"description": "Restrict results to workflows in this folder path. A path that names no folder narrows the result to nothing, so the response is an empty page rather than an error.",

"$ref": "#/components/schemas/FolderPathInput"

}

},

{

"name": "deployedOnly",

"in": "query",

"required": false,

"description": "Return only workflows with an active deployment when true.",

"schema": {

"description": "Return only workflows with an active deployment when true.",

"type": "boolean"

}

},

{

"name": "limit",

"in": "query",

"required": false,

"description": "Maximum workflows to return per page. Must be a whole number from 1 to 100. Defaults to 50.",

"schema": {

"default": 50,

"description": "Maximum workflows to return per page. Must be a whole number from 1 to 100. Defaults to 50.",

"type": "integer",

"minimum": 1,

"maximum": 100

}

},

{

"name": "cursor",

"in": "query",

"required": false,

"description": "Opaque cursor from the previous page. Send it back with the same sort and filters; only `limit` may change. Change anything else and pagination must restart without a cursor.",

"schema": {

"description": "Opaque cursor from the previous page. Send it back with the same sort and filters; only `limit` may change. Change anything else and pagination must restart without a cursor.",

"type": "string",

"minLength": 1

}

},

{

"name": "search",

"in": "query",

"required": false,

"description": "Case-insensitive substring match against the resource name.",

"schema": {

"description": "Case-insensitive substring match against the resource name.",

"type": "string",

"minLength": 1,

"maxLength": 200

}

},

{

"name": "sortBy",

"in": "query",

"required": false,

"description": "Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order.",

"schema": {

"default": "position",

"description": "Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order.",

"type": "string",

"enum": ["position", "name", "createdAt", "updatedAt", "runCount"]

}

},

{

"name": "sortOrder",

"in": "query",

"required": false,

"description": "Sort direction.",

"schema": {

"default": "asc",

"description": "Sort direction.",

"type": "string",

"enum": ["asc", "desc"]

}

}

],

"responses": {

"200": {

"description": "A page of workflows.",

"headers": {

"X-RateLimit-Limit": {

"$ref": "#/components/headers/X-RateLimit-Limit"

},

"X-RateLimit-Remaining": {

"$ref": "#/components/headers/X-RateLimit-Remaining"

},

"X-RateLimit-Reset": {

"$ref": "#/components/headers/X-RateLimit-Reset"

}

},

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/WorkflowListResponse"

}

}

}

},

"400": {

"$ref": "#/components/responses/BadRequest"

},

"401": {

"$ref": "#/components/responses/Unauthorized"

},

"403": {

"$ref": "#/components/responses/Forbidden"

},

"404": {

"$ref": "#/components/responses/NotFound"

},

"413": {

"$ref": "#/components/responses/PayloadTooLarge"

},

"429": {

"$ref": "#/components/responses/RateLimited"

},

"500": {

"$ref": "#/components/responses/InternalError"

},

"503": {

"$ref": "#/components/responses/ServiceUnavailable"

}

}

},

"post": {

"operationId": "createWorkflowV2",

"summary": "Create Workflow",

"description": "Create a workflow in a workspace root or canonical workflow folder. The response carries the blocks the platform seeded the workflow with, so the start block's id is available without a second request — attach edges to it directly. A workspace folder tree over 10,000 folders is a `413`.",

"tags": ["Workflows"],

"requestBody": {

"required": true,

"description": "Name, description, workspace, and optional folder for a new workflow.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/CreateWorkflowRequest"

}

}

}

},

"responses": {

"201": {

"description": "The created workflow.",

"headers": {

"X-RateLimit-Limit": {

"$ref": "#/components/headers/X-RateLimit-Limit"

},

"X-RateLimit-Remaining": {

"$ref": "#/components/headers/X-RateLimit-Remaining"

},

"X-RateLimit-Reset": {

"$ref": "#/components/headers/X-RateLimit-Reset"

}

},

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/CreateWorkflowResponse"

}

}

}

},

"400": {

"$ref": "#/components/responses/BadRequest"

},

"401": {

"$ref": "#/components/responses/Unauthorized"

},

"403": {

"$ref": "#/components/responses/Forbidden"

},

"404": {

"$ref": "#/components/responses/NotFound"

},

"409": {

"$ref": "#/components/responses/Conflict"

},

"413": {

"$ref": "#/components/responses/PayloadTooLarge"

},

"415": {

"$ref": "#/components/responses/UnsupportedMediaType"

},

"423": {

"$ref": "#/components/responses/Locked"

},

"429": {

"$ref": "#/components/responses/RateLimited"

},

"500": {

"$ref": "#/components/responses/InternalError"

},

"503": {

"$ref": "#/components/responses/ServiceUnavailable"

}

}

}

},

"/api/v2/workflows/{workflowId}/state": {

"get": {

"operationId": "getWorkflowState",

"summary": "Get Workflow State",

"description": "Get the editable draft graph of a workflow: blocks, edges, the loop and parallel containers derived from them, and variables. This is the pollable read — it records no audit event, and `HEAD` mirrors `GET`. The payload is **unsanitized**: it carries workspace-scoped `credentialId`, `knowledgeBaseId`, and `tableId` values verbatim, so it is not portable to another workspace. Use `GET /workflows/{workflowId}/export` for a portable, sanitized copy — and note that export is not a read-modify-write source, because sanitizing it drops every credential binding. Unknown members are stripped, so what this returns is exactly the set of keys `PUT /workflows/{workflowId}/state` accepts.",

"tags": ["Workflows"],

"parameters": [

{

"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"]

}

}

],

"responses": {

"200": {

"description": "The workflow draft graph.",

"headers": {

"X-RateLimit-Limit": {

"$ref": "#/components/headers/X-RateLimit-Limit"

},

"X-RateLimit-Remaining": {

"$ref": "#/components/headers/X-RateLimit-Remaining"

},

"X-RateLimit-Reset": {

"$ref": "#/components/headers/X-RateLimit-Reset"

}

},

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/WorkflowStateResponse"

}

}

}

},

"400": {

"$ref": "#/components/responses/BadRequest"

},

"401": {

"$ref": "#/components/responses/Unauthorized"

},

"403": {

"$ref": "#/components/responses/Forbidden"

},

"404": {

"$ref": "#/components/responses/NotFound"

},

"429": {

"$ref": "#/components/responses/RateLimited"

},

"500": {

"$ref": "#/components/responses/InternalError"

},

"503": {

"$ref": "#/components/responses/ServiceUnavailable"

}

}

},

"put": {

"operationId": "replaceWorkflowState",

"summary": "Replace Workflow State",

"description": "Replace a workflow’s editable draft graph wholesale. `loops` and `parallels` are accepted but ignored — both are recomputed from `blocks`. Omitting `variables` leaves the stored variables untouched.\n\nLast write wins: concurrent writers are serialized by a row lock, so each lands a complete self-consistent graph and the later one replaces the earlier entirely. There is no partially-written state. Ids are the one conflict that is detected: block, edge, and subflow ids are globally unique, so a body carrying an id another workflow already owns is refused with `409` rather than written.\n\nThis does not change what the deployed endpoint serves. Deployments are immutable versioned snapshots, and no schedule or webhook registration is touched. The only visible consequence is that `needsRedeployment` becomes true; `POST /workflows/{workflowId}/deploy` publishes the draft.\n\n`lint` is advisory and never blocks the write. `lint.fieldIssues` is the most actionable part for a headless builder — it names blocks missing a required field, which fail at run time — and `lint.unresolvedReferences` names credential, resource, tool, and skill values that do not resolve. A workspace API key is rejected with `403`; use a personal API key.\n\nSet `?dryRun=true` to validate and lint without persisting: nothing is written, no audit entry is recorded, and collaborators are not notified. The response carries the same shape and the same validation and `lint` findings the committed write would, with `dryRun: true` — including the warnings the write’s own preparation step raises, and the same `409` when an id is already owned by another workflow. Only `needsRedeployment` differs: it describes the state before the write.",

"tags": ["Workflows"],

"parameters": [

{

"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 persisting. The response is identical to the committed write of the same body, so a caller can inspect `lint` and then re-send the request for real. Nothing is written, no audit entry is recorded, and collaborators are not notified.",

"schema": {

"description": "Validate and lint without persisting. The response is identical to the committed write of the same body, so a caller can inspect `lint` and then re-send the request for real. Nothing is written, no audit entry is recorded, and collaborators are not notified.",

"type": "boolean"

}

}

],

"requestBody": {

"required": true,

"description": "A complete replacement draft graph for a workflow.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ReplaceWorkflowStateRequest"

}

}

}

},

"responses": {

"200": {

"description": "The draft graph was replaced.",

"headers": {

"X-RateLimit-Limit": {

"$ref": "#/components/headers/X-RateLimit-Limit"

},

"X-RateLimit-Remaining": {

"$ref": "#/components/headers/X-RateLimit-Remaining"

},

"X-RateLimit-Reset": {

"$ref": "#/components/headers/X-RateLimit-Reset"

}

},

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ReplaceWorkflowStateResponse"

}

}

}

},

"400": {

"$ref": "#/components/responses/BadRequest"

},

"401": {

"$ref": "#/components/responses/Unauthorized"

},

"403": {

"$ref": "#/components/responses/Forbidden"

},

"404": {

"$ref": "#/components/responses/NotFound"

},

"409": {

"$ref": "#/components/responses/Conflict"

},

"413": {

"$ref": "#/components/responses/PayloadTooLarge"

},

"415": {

"$ref": "#/components/responses/UnsupportedMediaType"

},

"423": {

"$ref": "#/components/responses/Locked"

},

"429": {

"$ref": "#/components/responses/RateLimited"

},

"500": {

"$ref": "#/components/responses/InternalError"

},

"503": {

"$ref": "#/components/responses/ServiceUnavailable"

}

}

}

},

"/api/v2/workflows/{workflowId}/operations": {

"post": {

"operationId": "applyWorkflowOperations",

"summary": "Apply Workflow Operations",

"description": "Apply a batch of semantic edits — add, edit, delete, and subflow membership changes — to a workflow graph, plus an optional set of block enable/disable changes.\n\nBest-effort per operation, atomic per write. The engine applies what it can to an in-memory graph and reports the rest in `skipped`, each with a machine-readable `type`; exactly one write of the fully-resolved graph then happens, so there is never a partially-applied graph. `deferred` is **not** a failure list: a forward-referencing edge is wired automatically once its target block exists, in this batch or a later one, so re-issuing a deferred edge is wrong.\n\nSet `atomic` to fail closed: any genuine skipped item, or any block input that would be dropped rather than persisted, then aborts before the write and answers `409` with `error.details.code: \"OPERATIONS_NOT_APPLIED\"`, the same `skipped` array, and a `droppedInputs` array, having persisted nothing.\n\nA `block_id` you supply on an `add` or `insert_into_subflow` is only a label unless it is already a UUID: the engine mints one and returns the pairing in `mintedBlockIds`. References between operations in the same batch are remapped for you, so `triage` can be wired up in the same call it is created in — but a later request must use the minted id. Send your own UUIDs when you want an id you chose to survive across requests.\n\nOperation `params` is an open object because the accepted inputs come from the block registry, not from this contract — see the per-operation schemas for the envelope: `inputs` keyed by sub-block id, with `retry`, `triggerMode` and `advancedMode` beside it rather than inside it, and `connections` keyed by source handle. `GET /blocks/{blockId}` publishes the inputs a given block type accepts. The Agent block’s `inputs.tools` value is the important exception to that open catalog shape: it is published here as the named `AgentToolInput` union, covering catalog integrations, workspace custom tools, and MCP tools.\n\n`lint` is advisory and never blocks the write. `lint.fieldIssues` is the most actionable part for a headless builder — it names blocks missing a required field, which fail at run time — and `lint.unresolvedReferences` names credential, resource, tool, and skill values that do not resolve. Those values stay persisted; only `inputValidationErrors` lists inputs that were actually dropped.\n\nAs with `PUT /workflows/{workflowId}/state`, this changes only the draft; deploy to publish it. A workspace API key is rejected with `403`; use a personal API key.\n\nSet `?dryRun=true` to validate and lint without persisting: nothing is written, no audit entry is recorded, and collaborators are not notified. The response carries the same shape and the same validation and `lint` findings the committed write would, with `dryRun: true` — including the warnings the write’s own preparation step raises, and the same `409` when an id is already owned by another workflow. Only `needsRedeployment` differs: it describes the state before the write.",

"tags": ["Workflows"],

"parameters": [

{

"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 persisting. The response is identical to the committed write of the same body, so a caller can inspect `lint` and then re-send the request for real. Nothing is written, no audit entry is recorded, and collaborators are not notified.",

"schema": {

"description": "Validate and lint without persisting. The response is identical to the committed write of the same body, so a caller can inspect `lint` and then re-send the request for real. Nothing is written, no audit entry is recorded, and collaborators are not notified.",

"type": "boolean"

}

}

],

"requestBody": {

"required": true,

"description": "A batch of semantic edits against a workflow graph.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ApplyWorkflowOperationsRequest"

}

}

}

},

"responses": {

"200": {

"description": "The batch was applied.",

"headers": {

"X-RateLimit-Limit": {

"$ref": "#/components/headers/X-RateLimit-Limit"

},

"X-RateLimit-Remaining": {

"$ref": "#/components/headers/X-RateLimit-Remaining"

},

"X-RateLimit-Reset": {

"$ref": "#/components/headers/X-RateLimit-Reset"

}

},

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ApplyWorkflowOperationsResponse"

}

}

}

},

"400": {

"$ref": "#/components/responses/BadRequest"

},

"401": {

"$ref": "#/components/responses/Unauthorized"

},

"403": {

"$ref": "#/components/responses/Forbidden"

},

"404": {

"$ref": "#/components/responses/NotFound"

},

"409": {

"$ref": "#/components/responses/Conflict"

},

"413": {

"$ref": "#/components/responses/PayloadTooLarge"

},

"415": {

"$ref": "#/components/responses/UnsupportedMediaType"

},

"423": {

"$ref": "#/components/responses/Locked"

},

"429": {

"$ref": "#/components/responses/RateLimited"

},

"500": {

"$ref": "#/components/responses/InternalError"

},

"503": {

"$ref": "#/components/responses/ServiceUnavailable"

}

}

}

},

"/api/v2/workflows/{workflowId}/variables": {

"patch": {

"operationId": "applyWorkflowVariables",

"summary": "Update Workflow Variables",

"description": "Add, edit, and delete a workflow’s variables. Operations are matched by variable `name` and applied in order; a batch that changes nothing answers `200` with `changed: false`. Values are coerced to the declared `type`, and a value that cannot be coerced is stored as supplied. Read the current set from `variables` on `GET /workflows/{workflowId}`.",

"tags": ["Workflows"],

"parameters": [

{

"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"]

}

}

],

"requestBody": {

"required": true,

"description": "Additions, edits, and deletions against a workflow’s variables.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ApplyWorkflowVariablesRequest"

}

}

}

},

"responses": {

"200": {

"description": "The variable set after the batch.",

"headers": {

"X-RateLimit-Limit": {

"$ref": "#/components/headers/X-RateLimit-Limit"

},

"X-RateLimit-Remaining": {

"$ref": "#/components/headers/X-RateLimit-Remaining"

},

"X-RateLimit-Reset": {

"$ref": "#/components/headers/X-RateLimit-Reset"

}

},

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ApplyWorkflowVariablesResponse"

}

}

}

},

"400": {

"$ref": "#/components/responses/BadRequest"

},

"401": {

"$ref": "#/components/responses/Unauthorized"

},

"403": {

"$ref": "#/components/responses/Forbidden"

},

"404": {

"$ref": "#/components/responses/NotFound"

},

"409": {

"$ref": "#/components/responses/Conflict"

},

"413": {

"$ref": "#/components/responses/PayloadTooLarge"

},

"415": {

"$ref": "#/components/responses/UnsupportedMediaType"

},

"423": {

"$ref": "#/components/responses/Locked"

},

"429": {

"$ref": "#/components/responses/RateLimited"

},

"500": {

"$ref": "#/components/responses/InternalError"

},

"503": {

"$ref": "#/components/responses/ServiceUnavailable"

}

}

}

},

"/api/v2/workflows/{workflowId}/duplicate": {

"post": {

"operationId": "duplicateWorkflow",

"summary": "Duplicate Workflow",

"description": "Copy a workflow, including its blocks, edges, subflows, and variables, into the same workspace. Omitting `name` reuses the source name; a collision inside the destination folder is deduplicated rather than refused. A workspace folder tree over 10,000 folders is a `413`.",

"tags": ["Workflows"],

"parameters": [

{

"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"]

}

}

],

"requestBody": {

"required": true,

"description": "Optional name and destination folder for the copy.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/DuplicateWorkflowRequest"

}

}

}

},

"responses": {

"201": {

"description": "The created copy.",

"headers": {

"X-RateLimit-Limit": {

"$ref": "#/components/headers/X-RateLimit-Limit"

},

"X-RateLimit-Remaining": {

"$ref": "#/components/headers/X-RateLimit-Remaining"

},

"X-RateLimit-Reset": {

"$ref": "#/components/headers/X-RateLimit-Reset"

}

},

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/DuplicateWorkflowResponse"

}

}

}

},

"400": {

"$ref": "#/components/responses/BadRequest"

},

"401": {

"$ref": "#/components/responses/Unauthorized"

},

"403": {

"$ref": "#/components/responses/Forbidden"

},

"404": {

"$ref": "#/components/responses/NotFound"

},

"409": {

"$ref": "#/components/responses/Conflict"

},

"413": {

"$ref": "#/components/responses/PayloadTooLarge"

},

"415": {

"$ref": "#/components/responses/UnsupportedMediaType"

},

"423": {

"$ref": "#/components/responses/Locked"

},

"429": {

"$ref": "#/components/responses/RateLimited"

},

"500": {

"$ref": "#/components/responses/InternalError"

},

"503": {

"$ref": "#/components/responses/ServiceUnavailable"

}

}

}

},

"/api/v2/workflows/{workflowId}/restore": {

"post": {

"operationId": "restoreWorkflow",

"summary": "Restore Workflow",

"description": "Bring an archived workflow back, along with the schedules, webhooks, MCP tools, and chats that were archived with it. A workflow that is not archived answers `409`. A workflow whose folder was archived is restored to the workspace root. A workspace folder tree over 10,000 folders is a `413`.",

"tags": ["Workflows"],

"parameters": [

{

"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"]

}

}

],

"responses": {

"200": {

"description": "The restored workflow.",

"headers": {

"X-RateLimit-Limit": {

"$ref": "#/components/headers/X-RateLimit-Limit"

},

"X-RateLimit-Remaining": {

"$ref": "#/components/headers/X-RateLimit-Remaining"

},

"X-RateLimit-Reset": {

"$ref": "#/components/headers/X-RateLimit-Reset"

}

},

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/RestoreWorkflowResponse"

}

}

}

},

"400": {

"$ref": "#/components/responses/BadRequest"

},

"401": {

"$ref": "#/components/responses/Unauthorized"

},

"403": {

"$ref": "#/components/responses/Forbidden"

},

"404": {

"$ref": "#/components/responses/NotFound"

},

"409": {

"$ref": "#/components/responses/Conflict"

},

"413": {

"$ref": "#/components/responses/PayloadTooLarge"

},

"423": {

"$ref": "#/components/responses/Locked"

},

"429": {

"$ref": "#/components/responses/RateLimited"

},

"500": {

"$ref": "#/components/responses/InternalError"

},

"503": {

"$ref": "#/components/responses/ServiceUnavailable"

}

}

}

},

"/api/v2/workflows/move": {

"post": {

"operationId": "moveWorkflows",

"summary": "Move Workflows",

"description": "Relocate up to 100 workflows into one folder. Explicitly best-effort: each workflow moves in its own transaction, and one that is absent from the workspace, archived, or locked lands in `failed` while the rest still move. Duplicate ids are collapsed. A workspace folder tree over 10,000 folders is a `413`.",

"tags": ["Workflows"],

"requestBody": {

"required": true,

"description": "Workflows to relocate and the folder to relocate them into.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/MoveWorkflowsRequest"

}

}

}

},

"responses": {

"200": {

"description": "Which workflows moved and which did not.",

"headers": {

"X-RateLimit-Limit": {

"$ref": "#/components/headers/X-RateLimit-Limit"

},

"X-RateLimit-Remaining": {

"$ref": "#/components/headers/X-RateLimit-Remaining"

},

"X-RateLimit-Reset": {

"$ref": "#/components/headers/X-RateLimit-Reset"

}

},

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/MoveWorkflowsResponse"

}

}

}

},

"400": {

"$ref": "#/components/responses/BadRequest"

},

"401": {

"$ref": "#/components/responses/Unauthorized"

},

"403": {

"$ref": "#/components/responses/Forbidden"

},

"404": {

"$ref": "#/components/responses/NotFound"

},

"413": {

"$ref": "#/components/responses/PayloadTooLarge"

},

"415": {

"$ref": "#/components/responses/UnsupportedMediaType"

},

"429": {

"$ref": "#/components/responses/RateLimited"

},

"500": {

"$ref": "#/components/responses/InternalError"

},

"503": {

"$ref": "#/components/responses/ServiceUnavailable"

}

}

}

},

"/api/v2/workflows/{workflowId}": {

"get": {

"operationId": "getWorkflow",

"summary": "Get Workflow",

"description": "Get a workflow with its variables and deployed API-trigger inputs. A workspace folder tree over 10,000 folders is a `413`.",

"tags": ["Workflows"],

"parameters": [

{

"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"]

}

}

],

"responses": {

"200": {

"description": "The requested workflow.",

"headers": {

"X-RateLimit-Limit": {

"$ref": "#/components/headers/X-RateLimit-Limit"

},

"X-RateLimit-Remaining": {

"$ref": "#/components/headers/X-RateLimit-Remaining"

},

"X-RateLimit-Reset": {

"$ref": "#/components/headers/X-RateLimit-Reset"

}

},

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/WorkflowDetailResponse"

}

}

}

},

"400": {

"$ref": "#/components/responses/BadRequest"

},

"401": {

"$ref": "#/components/responses/Unauthorized"

},

"403": {

"$ref": "#/components/responses/Forbidden"

},

"404": {

"$ref": "#/components/responses/NotFound"

},

"413": {

"$ref": "#/components/responses/PayloadTooLarge"

},

"429": {

"$ref": "#/components/responses/RateLimited"

},

"500": {

"$ref": "#/components/responses/InternalError"

},

"503": {

"$ref": "#/components/responses/ServiceUnavailable"

}

}

},

"patch": {

"operationId": "updateWorkflowV2",

"summary": "Update Workflow",

"description": "Rename, describe, or move a workflow to a canonical folder path. A workspace folder tree over 10,000 folders is a `413`.",

"tags": ["Workflows"],

"parameters": [

{

"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"]

}

}

],

"requestBody": {

"required": true,

"description": "Fields to update on an existing workflow.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/UpdateWorkflowRequest"

}

}

}

},

"responses": {

"200": {

"description": "The updated workflow.",

"headers": {

"X-RateLimit-Limit": {

"$ref": "#/components/headers/X-RateLimit-Limit"

},

"X-RateLimit-Remaining": {

"$ref": "#/components/headers/X-RateLimit-Remaining"

},

"X-RateLimit-Reset": {

"$ref": "#/components/headers/X-RateLimit-Reset"

}

},

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/UpdateWorkflowResponse"

}

}

}

},

"400": {

"$ref": "#/components/responses/BadRequest"

},

"401": {

"$ref": "#/components/responses/Unauthorized"

},

"403": {

"$ref": "#/components/responses/Forbidden"

},

"404": {

"$ref": "#/components/responses/NotFound"

},

"409": {

"$ref": "#/components/responses/Conflict"

},

"413": {

"$ref": "#/components/responses/PayloadTooLarge"

},

"415": {

"$ref": "#/components/responses/UnsupportedMediaType"

},

"423": {

"$ref": "#/components/responses/Locked"

},