The server is running. Start, resume, and monitor stateful workflows via the REST API — or explore the interactive documentation below.
Developer Resources
Browse all endpoints in Swagger UI. Try requests directly from your browser — no curl required.
Open Swagger UI →Machine-readable OpenAPI 3.0 JSON specification. Import into Postman, Insomnia, or any API tool.
Download JSON →Liveness probe endpoint — always open, no authentication required. Used by Kubernetes and load balancers.
View health →Product page for this engine — includes feature overview, node type reference, deployment guide, API reference, sample .drawio workflow models, and User Guide PDF.
Open project website →API Reference
| Method | Path | Auth | Description |
|---|---|---|---|
| POST | /workflows/start | Required | Start or resume a workflow instance. Body: {"model":"name","instance_id":"opt","context":{}} |
| POST | /workflows/<id>/continue | Required | Advance a paused instance. Intended for form submissions and manual approvals. |
| POST | /workflows/<id>/callback | Required | Deliver an async event to a waiting instance. Used internally for parallel branch coordination. |
| GET | /workflows/<id> | Required | Retrieve full persisted state: context, history, wait states. Requires ?model=<name> query param. |
| GET | /health | Open | Liveness probe. Returns {"status":"ok","uptime_seconds":N}. Always accessible. |
| GET | /metrics | Required | Runtime counters: total requests, completed, waiting, errored, in-flight instances. |
| GET | / | Open | This page — server landing page with live status and links to API documentation. |
| GET | /docs | Open | Interactive Swagger UI — browse and try all API endpoints from the browser. |
| GET | /openapi.json | Open | OpenAPI 3.0 specification in JSON format. Import into Postman or any compatible tool. |