Workflows
Create, validate, publish, run, version, and expose workflows.
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/public/workflows/{id} | Get a public workflow by visibility |
POST | /v1/public/workflows/{id}/executions | Create a client-trackable execution session for a public_execute workflow |
GET | /v1/public/workflows/{id}/meta | Get public metadata (name, description) for a workflow. No auth required — intentionally unauthenticated for OG image generation. Only returns title and description; no sensitive data is exposed. |
POST | /v1/public/workflows/{id}/run | Trigger a run for a public_execute workflow |
GET | /v1/public/workflows/{id}/runs | List runs for a public workflow |
GET | /v1/public/workflows/{id}/widget | Get public widget configuration for a workflow (no auth required) |
GET | /v1/workflows | Get all workflows |
POST | /v1/workflows | Create a new workflow |
DELETE | /v1/workflows/{id} | Archive a workflow (soft delete) |
GET | /v1/workflows/{id} | Get a workflow by ID |
PUT | /v1/workflows/{id} | Update a workflow (creates new version due to immutability) |
DELETE | /v1/workflows/{id}/draft | Discard the draft version of a workflow |
GET | /v1/workflows/{id}/draft | Get the draft version of a workflow |
PUT | /v1/workflows/{id}/fund-auto-swap | Update workflow fund auto-swap configuration |
GET | /v1/workflows/{id}/incoming-links | List workflows that target this workflow via a 'trigger-workflow' action node. |
GET | /v1/workflows/{id}/live | Get the live (active/paused) version of a workflow |
PUT | /v1/workflows/{id}/owner | Transfer workflow ownership to another organization member |
POST | /v1/workflows/{id}/pause | Pause a workflow |
POST | /v1/workflows/{id}/publish | Publish a draft workflow (validates cronjob intervals, activates) |
POST | /v1/workflows/{id}/refill | Refill remaining runs for a workflow |
POST | /v1/workflows/{id}/regenerate-descriptions | Regenerate AI descriptions for a workflow |
GET | /v1/workflows/{id}/resolve | Resolve workflow organization |
POST | /v1/workflows/{id}/resume | Resume a paused workflow |
POST | /v1/workflows/{id}/rollback | Rollback workflow to a previous version |
POST | /v1/workflows/{id}/run | Run a workflow with optional payload. Works for draft, active, and paused workflows. Does not count against maxRuns or enforce cooldown. |
GET | /v1/workflows/{id}/runs | List all runs for a specific workflow |
GET | /v1/workflows/{id}/runs/count | Count runs for a specific workflow, grouped by status |
GET | /v1/workflows/{id}/runs/stream | Stream workflow run events |
GET | /v1/workflows/{id}/schedule | Get next run time for a scheduled workflow |
GET | /v1/workflows/{id}/trigger-info | Get trigger info (e.g. Pipedream email address) for a workflow |
PATCH | /v1/workflows/{id}/ui-metadata | Update workflow UI metadata (node positions) in-place |
GET | /v1/workflows/{id}/versions | List all versions of a workflow |
GET | /v1/workflows/{id}/versions/{versionNumber} | Get a specific version of a workflow by version number |
GET | /v1/workflows/{id}/versions/count | Count total versions for a specific workflow |
PUT | /v1/workflows/{id}/visibility | Update workflow visibility level |
DELETE | /v1/workflows/{id}/widget | Disable public widget for a workflow |
POST | /v1/workflows/{id}/widget | Enable public widget for a workflow |
POST | /v1/workflows/batch-stats | Batch workflow stats |
GET | /v1/workflows/counts | Get workflow counts grouped by status (filter-aware). |
GET | /v1/workflows/owner-counts | Get workflow counts grouped by owner scope (yours/org/public). |
POST | /v1/workflows/validate | Validate a workflow definition without saving |
