Eden REST API
Workflow Run APIs
ProtocolREST / JSON
Base path
/api/v1AuthenticationBearer token
Workflow run APIs manage execution instances after a workflow is defined.
Run Lifecycle
Workflow Definition Version APIs
| Method | Route | Purpose |
|---|---|---|
| POST | /api/v1/workflows/{workflow}/runs | Start a workflow run. |
| GET | /api/v1/workflows/{workflow}/versions | List workflow versions. |
| GET | /api/v1/workflows/{workflow}/versions/{version} | Get a workflow version. |
| POST | /api/v1/workflows/{workflow}/versions/{version}/plan | Plan a workflow version. |
Run Management APIs
| Method | Route | Purpose |
|---|---|---|
| POST | /api/v1/workflow-runs/import | Import a workflow run. |
| GET | /api/v1/workflow-runs/{run_id} | Get a workflow run. |
| GET | /api/v1/workflow-runs/{run_id}/steps | Get run steps. |
| POST | /api/v1/workflow-runs/{run_id}/cancel | Cancel a run. |
| POST | /api/v1/workflow-runs/{run_id}/resume | Resume a run. |
| POST | /api/v1/workflow-runs/{run_id}/fork | Fork a run. |
| GET | /api/v1/workflow-runs/{run_id}/export | Export a run. |