Define and execute DAG-based multi-step workflows with branching, triggers, and agent task nodes

GET/api/executor-types

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length

payload?

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason?string

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length

payload?

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Query Parameters

enabled?string

Value in"true" | "false"

consecutiveErrorsMin?|

Range0 <= value

lastRunStatus?string

key?string

Non-unique asset directory namespace (for example shared/ or personal//drafts/). Runtime write boundaries normalize and validate the canonical form.

Length1 <= length <= 255

keyPrefix?string

Non-unique asset directory namespace (for example shared/ or personal//drafts/). Runtime write boundaries normalize and validate the canonical form.

Length1 <= length <= 255

fields?string

Value in"full" | "slim"

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length

key?string

Non-unique asset directory namespace (for example shared/ or personal//drafts/). Runtime write boundaries normalize and validate the canonical form.

Length1 <= length <= 255

description?string

definition*

triggers?array<||>

cooldown?

input?

triggerSchema?

params?

requiredParams?array<>

requires?array<>

dir?string

Length1 <= length

vcsRepo?string

Length1 <= length

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

update?array<>

Nodes to update (partial merge)

delete?array<>

Node IDs to delete

create?array<>

New nodes to add

onNodeFailure?string

Update the definition-level onNodeFailure behavior

Value in"fail" | "continue"

triggerSchema?|

Optional JSON-Schema describing the expected trigger payload shape. Pass an object to set/replace; pass null to clear; omit to leave unchanged. Validator subset: type, required, properties, enum, const, items. Other JSON-Schema keywords are silently ignored.

params?

requiredParams?array<>

requires?array<>

key?string

Non-unique asset directory namespace (for example shared/ or personal//drafts/). Runtime write boundaries normalize and validate the canonical form.

Length1 <= length <= 255

Response Body

`application/json`

curl -X PATCH "http://localhost:3013/api/workflows/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "key": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "definition": {
    "nodes": [
      {
        "id": "string",
        "type": "string",
        "label": "string",
        "config": {
          "property1": null,
          "property2": null
        },
        "next": "string",
        "validation": {
          "executor": "validate",
          "config": {
            "property1": null,
            "property2": null
          },
          "mustPass": false,
          "retry": {
            "maxRetries": 3,
            "strategy": "exponential",
            "baseDelayMs": 1000,
            "maxDelayMs": 60000
          }
        },
        "retry": {
          "maxRetries": 3,
          "strategy": "exponential",
          "baseDelayMs": 1000,
          "maxDelayMs": 60000
        },
        "inputs": {
          "property1": "string",
          "property2": "string"
        },
        "inputSchema": {
          "property1": null,
          "property2": null
        },
        "outputSchema": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "onNodeFailure": "fail"
  },
  "triggers": [],
  "cooldown": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0
  },
  "input": {
    "property1": "string",
    "property2": "string"
  },
  "triggerSchema": {
    "property1": null,
    "property2": null
  },
  "params": {
    "property1": null,
    "property2": null
  },
  "requiredParams": [
    "string"
  ],
  "requires": [
    "slack"
  ],
  "dir": "string",
  "vcsRepo": "string",
  "createdByAgentId": "string",
  "createdAt": "string",
  "lastUpdatedAt": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "favorite": true,
  "warnings": [
    "string"
  ]
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

PUT/api/workflows/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

key?string

Non-unique asset directory namespace (for example shared/ or personal//drafts/). Runtime write boundaries normalize and validate the canonical form.

Length1 <= length <= 255

description?string

definition?

triggers?array<||>

cooldown?|

input?|

triggerSchema?|

params?

requiredParams?array<>

requires?array<>

dir?|

Length1 <= length

vcsRepo?|

Length1 <= length

enabled?boolean

Response Body

`application/json`

curl -X PUT "http://localhost:3013/api/workflows/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "key": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "definition": {
    "nodes": [
      {
        "id": "string",
        "type": "string",
        "label": "string",
        "config": {
          "property1": null,
          "property2": null
        },
        "next": "string",
        "validation": {
          "executor": "validate",
          "config": {
            "property1": null,
            "property2": null
          },
          "mustPass": false,
          "retry": {
            "maxRetries": 3,
            "strategy": "exponential",
            "baseDelayMs": 1000,
            "maxDelayMs": 60000
          }
        },
        "retry": {
          "maxRetries": 3,
          "strategy": "exponential",
          "baseDelayMs": 1000,
          "maxDelayMs": 60000
        },
        "inputs": {
          "property1": "string",
          "property2": "string"
        },
        "inputSchema": {
          "property1": null,
          "property2": null
        },
        "outputSchema": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "onNodeFailure": "fail"
  },
  "triggers": [],
  "cooldown": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0
  },
  "input": {
    "property1": "string",
    "property2": "string"
  },
  "triggerSchema": {
    "property1": null,
    "property2": null
  },
  "params": {
    "property1": null,
    "property2": null
  },
  "requiredParams": [
    "string"
  ],
  "requires": [
    "slack"
  ],
  "dir": "string",
  "vcsRepo": "string",
  "createdByAgentId": "string",
  "createdAt": "string",
  "lastUpdatedAt": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "favorite": true,
  "warnings": [
    "string"
  ]
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

PATCH/api/workflows/{id}/nodes/{nodeId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

nodeId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type?string

Executor type: 'agent-task', 'script', 'swarm-script', 'raw-llm', 'system-one-decision', 'validate', 'property-match'

label?string

Human-readable label for UI display

config?

Executor-specific config. For agent-task: { template, outputSchema?, agentId?, routingReason?, routingNote?, tags?, priority?, dir?, vcsRepo?, model? }; configured agentId defaults routingReason to human_pinned. For script: { runtime, script, args?, timeout? }. For swarm-script: { scriptName, scope?, pinHash?, args?, fsMode?, timeoutMs? (1000-300000) }. For system-one-decision (typed decisions, Jev by default): { provider? ('typesafe' default | 'openrouter' | 'laya'; a literal, never a {{token}}), state, questions: { : { type: 'noul'|'choice'|'score', instructions, criteria? } }, returns: { : { type } }, model? (provider-specific; unset = the provider's default, and laya has none so it sends no model and picks its own checkpoint), timeoutMs?, maxRetries? (0-3), humanReview? { band: { min, max } (0-1, inclusive), approvers: { users?, roles?, policy }, title?, timeout?, notifications? } }; each provider needs its own global secret (TYPESAFE_API_KEY, OPENROUTER_API_KEY, or LAYA_API_KEY; laya also needs the global config LAYA_URL), and a save warns and a run fails before any node executes when one is missing; system-one-decision nodes must not set retry or validation.retry. With humanReview, an answer whose confidence is inside the band waits for a person (human-in-the-loop approval), and next must map ports { approved, rejected?, timeout? }. Agent-task templates and ordinary config values support {{interpolation}} from the node's inputs context, including trigger and declared upstream aliases. SECURITY: executable source for script/swarm-script nodes does not interpolate trigger.* or upstream node outputs; only input/workflow/swarm/run values are allowed in inline script source, and named swarm-script source is not workflow-interpolated. Pass dynamic values through config.args instead (inline script receives them as argv, with runtime: "bash" running bash -c ...args so args[0] is $0 and args[1] is $1; swarm-script receives its args object). NOTE: config.outputSchema on agent-task nodes validates the AGENT's raw JSON output, while node-level outputSchema validates the EXECUTOR's return value ({taskId, taskOutput}).

next?|array<>|

Next node(s): string for simple chaining, string[] for fan-out to parallel nodes, or record for port-based routing ({pass: 'a', fail: 'b'})

validation?

retry?

inputs?

REQUIRED for cross-node data access. Maps local names to context paths. Without this, upstream step outputs are NOT available for interpolation; built-in trigger/input/workflow/swarm/run context remains available. Example: { "cityData": "generate-city" } → use {{cityData.taskOutput.field}} in config templates. For trigger data: { "pr": "trigger.pullRequest" }. This mapping works in agent-task templates and ordinary config, but executable script/swarm-script source excludes trigger and upstream-output aliases. Route those dynamic values through config.args (argv for inline scripts) instead.

inputSchema?

JSON Schema to validate resolved inputs before execution

outputSchema?

JSON Schema to validate the executor's output (e.g. {taskId, taskOutput} for agent-task). Different from config.outputSchema which validates the agent's raw output.

Response Body

`application/json`

curl -X PATCH "http://localhost:3013/api/workflows/string/nodes/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "key": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "definition": {
    "nodes": [
      {
        "id": "string",
        "type": "string",
        "label": "string",
        "config": {
          "property1": null,
          "property2": null
        },
        "next": "string",
        "validation": {
          "executor": "validate",
          "config": {
            "property1": null,
            "property2": null
          },
          "mustPass": false,
          "retry": {
            "maxRetries": 3,
            "strategy": "exponential",
            "baseDelayMs": 1000,
            "maxDelayMs": 60000
          }
        },
        "retry": {
          "maxRetries": 3,
          "strategy": "exponential",
          "baseDelayMs": 1000,
          "maxDelayMs": 60000
        },
        "inputs": {
          "property1": "string",
          "property2": "string"
        },
        "inputSchema": {
          "property1": null,
          "property2": null
        },
        "outputSchema": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "onNodeFailure": "fail"
  },
  "triggers": [],
  "cooldown": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0
  },
  "input": {
    "property1": "string",
    "property2": "string"
  },
  "triggerSchema": {
    "property1": null,
    "property2": null
  },
  "params": {
    "property1": null,
    "property2": null
  },
  "requiredParams": [
    "string"
  ],
  "requires": [
    "slack"
  ],
  "dir": "string",
  "vcsRepo": "string",
  "createdByAgentId": "string",
  "createdAt": "string",
  "lastUpdatedAt": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "favorite": true,
  "warnings": [
    "string"
  ]
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

GET/api/workflows/{id}/runs

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Query Parameters

status?string

limit?integer

Range1 <= value <= 100

offset?|

Range0 <= value

Response Body

`application/json`

curl -X GET "http://localhost:3013/api/workflows/string/runs"

{
  "runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
      "status": "running",
      "triggerData": null,
      "error": "string",
      "createdBy": "string",
      "startedAt": "string",
      "lastUpdatedAt": "string",
      "finishedAt": "string",
      "parentStepId": "string"
    }
  ],
  "page": {
    "limit": 0,
    "offset": 0,
    "total": 0,
    "hasMore": true,
    "nextOffset": 0
  }
}

POST/api/workflows/{id}/trigger

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "http://localhost:3013/api/workflows/string/trigger"

{
  "runId": "string",
  "skipped": true
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

POST/api/workflows/{id}/trigger/validate

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "http://localhost:3013/api/workflows/string/trigger/validate"

{
  "valid": true,
  "schema": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

GET/api/workflows/{id}/versions

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "http://localhost:3013/api/workflows/string/versions"

{
  "versions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
      "version": 1,
      "snapshot": {
        "name": "string",
        "description": "string",
        "definition": {
          "nodes": [
            {
              "id": "string",
              "type": "string",
              "label": "string",
              "config": {
                "property1": null,
                "property2": null
              },
              "next": "string",
              "validation": {
                "executor": "validate",
                "config": {
                  "property1": null,
                  "property2": null
                },
                "mustPass": false,
                "retry": {
                  "maxRetries": 3,
                  "strategy": "exponential",
                  "baseDelayMs": 1000,
                  "maxDelayMs": 60000
                }
              },
              "retry": {
                "maxRetries": 3,
                "strategy": "exponential",
                "baseDelayMs": 1000,
                "maxDelayMs": 60000
              },
              "inputs": {
                "property1": "string",
                "property2": "string"
              },
              "inputSchema": {
                "property1": null,
                "property2": null
              },
              "outputSchema": {
                "property1": null,
                "property2": null
              }
            }
          ],
          "onNodeFailure": "fail"
        },
        "triggers": [
          {
            "type": "webhook",
            "hmacSecret": "string",
            "hmacHeader": "X-Hub-Signature-256",
            "verification": {
              "format": "hmac-sha256",
              "header": "X-Hub-Signature-256"
            }
          }
        ],
        "cooldown": {
          "hours": 0,
          "minutes": 0,
          "seconds": 0
        },
        "input": {
          "property1": "string",
          "property2": "string"
        },
        "triggerSchema": {
          "property1": null,
          "property2": null
        },
        "params": {
          "property1": null,
          "property2": null
        },
        "requiredParams": [
          "string"
        ],
        "requires": [
          "slack"
        ],
        "dir": "string",
        "vcsRepo": "string",
        "enabled": true
      },
      "changedByAgentId": "string",
      "createdAt": "string"
    }
  ]
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

GET/api/workflows/{id}/versions/{version}

Authorization

bearerAuth

AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

version*integer

Range1 <= value

Response Body

`application/json`

curl -X GET "http://localhost:3013/api/workflows/string/versions/1"

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
  "version": 1,
  "snapshot": {
    "name": "string",
    "description": "string",
    "definition": {
      "nodes": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "config": {
            "property1": null,
            "property2": null
          },
          "next": "string",
          "validation": {
            "executor": "validate",
            "config": {
              "property1": null,
              "property2": null
            },
            "mustPass": false,
            "retry": {
              "maxRetries": 3,
              "strategy": "exponential",
              "baseDelayMs": 1000,
              "maxDelayMs": 60000
            }
          },
          "retry": {
            "maxRetries": 3,
            "strategy": "exponential",
            "baseDelayMs": 1000,
            "maxDelayMs": 60000
          },
          "inputs": {
            "property1": "string",
            "property2": "string"
          },
          "inputSchema": {
            "property1": null,
            "property2": null
          },
          "outputSchema": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "onNodeFailure": "fail"
    },
    "triggers": [
      {
        "type": "webhook",
        "hmacSecret": "string",
        "hmacHeader": "X-Hub-Signature-256",
        "verification": {
          "format": "hmac-sha256",
          "header": "X-Hub-Signature-256"
        }
      }
    ],
    "cooldown": {
      "hours": 0,
      "minutes": 0,
      "seconds": 0
    },
    "input": {
      "property1": "string",
      "property2": "string"
    },
    "triggerSchema": {
      "property1": null,
      "property2": null
    },
    "params": {
      "property1": null,
      "property2": null
    },
    "requiredParams": [
      "string"
    ],
    "requires": [
      "slack"
    ],
    "dir": "string",
    "vcsRepo": "string",
    "enabled": true
  },
  "changedByAgentId": "string",
  "createdAt": "string"
}

{
  "error": "string",
  "property1": null,
  "property2": null
}

Workflows

200application/json

200application/json

404application/json

200application/json

400application/json

200application/json

404application/json

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

404application/json

200application/json

201application/json

400application/json

204

404application/json

200application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

201application/json

400application/json

401application/json

404application/json

200application/json

400application/json

404application/json

200application/json

404application/json

200application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`