Eden REST API
Workflow APIs
ProtocolREST / JSON
Base path
/api/v1AuthenticationBearer token
Workflow definition APIs create and manage durable workflow specifications. Execution begins through the run route; POST /workflows/{workflow} is not a workflow execution route.
Definition Routes
| Method | Route | Purpose |
|---|---|---|
| POST | /api/v1/workflows | Create a workflow definition. |
| GET | /api/v1/workflows/{workflow} | Read a workflow definition. |
| PATCH | /api/v1/workflows/{workflow} | Update a workflow definition. |
| DELETE | /api/v1/workflows/{workflow} | Delete a workflow definition. |
Version And Planning Routes
| Method | Route | Purpose |
|---|---|---|
| GET | /api/v1/workflows/{workflow}/versions | List definition versions. |
| GET | /api/v1/workflows/{workflow}/versions/{version} | Read one version. |
| POST | /api/v1/workflows/{workflow}/versions/{version}/plan | Plan a version before execution. |
Start A Run
http
POST /api/v1/workflows/{workflow}/runs
Authorization: Bearer <token>
Content-Type: application/jsonThe request body depends on the registered workflow specification. The response identifies a run that can be inspected and controlled through the Workflow Run APIs.