API Reference
Workflows API
API surface for SOIT workflow definitions, versions, releases, and execution.
The workflows API manages graph-based automation and versioned workflow execution.
Prefix
/api/v1/workflowsEndpoint families
| Method | Path | Purpose |
|---|---|---|
| POST / GET | / | Create workflows; list with pagination |
| POST | /templates/ticket-triage | Create from the built-in ticket-triage template |
| GET | /workbench, /workbench/items | Workbench summary views |
| GET / PUT / DELETE | /{workflow_id} | Inspect, update, or delete a workflow |
| POST / GET | /{workflow_id}/versions | Create a draft version; list versions |
| GET | /{workflow_id}/version/current | Current head version |
| GET | /{workflow_id}/releases | Release ledger |
| POST | /{workflow_id}/publish, /{workflow_id}/rollback | Move the live release pointer |
| POST | /{workflow_id}/execute, /{workflow_id}/stream | Execute (sync or streaming) |
| POST | /{workflow_id}/runs/{run_id}/pause … /resume / /cancel / /fail / /retry / /replay | Run-level execution control |
| GET / POST | /{workflow_id}/dsl | Export or import the workflow graph as DSL |
Related prefixes
/api/v1/tasks,/api/v1/runs— execution state and node-level traces/api/v1/plugins— plugin-exported workflow node types
Notes
- Node executions emit run steps; metered nodes write cost entries.
- Replay and retry create new runs/steps — history is append-only.