> ## Documentation Index
> Fetch the complete documentation index at: https://docs.b3os.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Workflows

Create, validate, publish, run, version, and expose workflows.

| Method   | Endpoint                                                                                                                                       | Description                                                                                                                                                                                                                                                                                  |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `GET`    | [/v1/public/workflows/&#123;id&#125;](/api/reference/get-v1-public-workflows-id-)                                                              | Get a public workflow by visibility                                                                                                                                                                                                                                                          |
| `POST`   | [/v1/public/workflows/&#123;id&#125;/executions](/api/reference/post-v1-public-workflows-id-executions)                                        | Create a client-trackable execution session for a public_execute workflow                                                                                                                                                                                                                    |
| `GET`    | [/v1/public/workflows/&#123;id&#125;/meta](/api/reference/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/&#123;id&#125;/run](/api/reference/post-v1-public-workflows-id-run)                                                      | Trigger a run for a public_execute workflow                                                                                                                                                                                                                                                  |
| `GET`    | [/v1/public/workflows/&#123;id&#125;/runs](/api/reference/get-v1-public-workflows-id-runs)                                                     | List runs for a public workflow                                                                                                                                                                                                                                                              |
| `GET`    | [/v1/public/workflows/&#123;id&#125;/widget](/api/reference/get-v1-public-workflows-id-widget)                                                 | Get public widget configuration for a workflow \(no auth required\)                                                                                                                                                                                                                          |
| `GET`    | [/v1/workflows](/api/reference/get-v1-workflows)                                                                                               | Get all workflows                                                                                                                                                                                                                                                                            |
| `POST`   | [/v1/workflows](/api/reference/post-v1-workflows)                                                                                              | Create a new workflow                                                                                                                                                                                                                                                                        |
| `DELETE` | [/v1/workflows/&#123;id&#125;](/api/reference/delete-v1-workflows-id-)                                                                         | Archive a workflow \(soft delete\)                                                                                                                                                                                                                                                           |
| `GET`    | [/v1/workflows/&#123;id&#125;](/api/reference/get-v1-workflows-id-)                                                                            | Get a workflow by ID                                                                                                                                                                                                                                                                         |
| `PUT`    | [/v1/workflows/&#123;id&#125;](/api/reference/put-v1-workflows-id-)                                                                            | Update a workflow. A content change creates a new draft version \(workflows are immutable\); an update whose content matches the current version is a no-op that returns the current version unchanged.                                                                                      |
| `GET`    | [/v1/workflows/&#123;id&#125;/analyze-funds](/api/reference/get-v1-workflows-id-analyze-funds)                                                 | Analyze the fund requirements of a workflow without executing it. Returns resolved \(wallet, chain, token, amount\) tuples for every action that moves money, plus a 'balance' row per requirement when the wallet-balances client is configured. The endpoint is read-only and does not consume CU. |
| `DELETE` | [/v1/workflows/&#123;id&#125;/draft](/api/reference/delete-v1-workflows-id-draft)                                                              | Discard the draft version of a workflow                                                                                                                                                                                                                                                      |
| `GET`    | [/v1/workflows/&#123;id&#125;/draft](/api/reference/get-v1-workflows-id-draft)                                                                 | Get the draft version of a workflow                                                                                                                                                                                                                                                          |
| `PUT`    | [/v1/workflows/&#123;id&#125;/fund-auto-swap](/api/reference/put-v1-workflows-id-fund-auto-swap)                                               | Update workflow fund auto-swap configuration                                                                                                                                                                                                                                                 |
| `GET`    | [/v1/workflows/&#123;id&#125;/incoming-links](/api/reference/get-v1-workflows-id-incoming-links)                                               | List workflows that target this workflow via a 'trigger-workflow' action node.                                                                                                                                                                                                               |
| `GET`    | [/v1/workflows/&#123;id&#125;/live](/api/reference/get-v1-workflows-id-live)                                                                   | Get the live \(active/paused\) version of a workflow                                                                                                                                                                                                                                         |
| `PUT`    | [/v1/workflows/&#123;id&#125;/owner](/api/reference/put-v1-workflows-id-owner)                                                                 | Transfer workflow ownership to another organization member                                                                                                                                                                                                                                   |
| `POST`   | [/v1/workflows/&#123;id&#125;/pause](/api/reference/post-v1-workflows-id-pause)                                                                | Pause a workflow                                                                                                                                                                                                                                                                             |
| `POST`   | [/v1/workflows/&#123;id&#125;/publish](/api/reference/post-v1-workflows-id-publish)                                                            | Publish a draft workflow \(validates cronjob intervals, activates\)                                                                                                                                                                                                                          |
| `POST`   | [/v1/workflows/&#123;id&#125;/refill](/api/reference/post-v1-workflows-id-refill)                                                              | Refill remaining runs for a workflow                                                                                                                                                                                                                                                         |
| `POST`   | [/v1/workflows/&#123;id&#125;/regenerate-descriptions](/api/reference/post-v1-workflows-id-regenerate-descriptions)                            | Regenerate AI descriptions for a workflow                                                                                                                                                                                                                                                    |
| `POST`   | [/v1/workflows/&#123;id&#125;/release](/api/reference/post-v1-workflows-id-release)                                                            | Publish a workflow and its generated app together as one release                                                                                                                                                                                                                             |
| `GET`    | [/v1/workflows/&#123;id&#125;/releases](/api/reference/get-v1-workflows-id-releases)                                                           | List the release history of a workflow \(newest first\)                                                                                                                                                                                                                                      |
| `POST`   | [/v1/workflows/&#123;id&#125;/releases/&#123;releaseVersion&#125;/revert](/api/reference/post-v1-workflows-id-releases-release-version-revert) | Revert a workflow to a prior release \(workflow + generated app\)                                                                                                                                                                                                                            |
| `GET`    | [/v1/workflows/&#123;id&#125;/resolve](/api/reference/get-v1-workflows-id-resolve)                                                             | Resolve workflow organization                                                                                                                                                                                                                                                                |
| `POST`   | [/v1/workflows/&#123;id&#125;/resume](/api/reference/post-v1-workflows-id-resume)                                                              | Resume a paused workflow                                                                                                                                                                                                                                                                     |
| `POST`   | [/v1/workflows/&#123;id&#125;/revert-to-version](/api/reference/post-v1-workflows-id-revert-to-version)                                        | Revert a workflow to a prior workflow version \(records a release with no app\)                                                                                                                                                                                                              |
| `POST`   | [/v1/workflows/&#123;id&#125;/rollback](/api/reference/post-v1-workflows-id-rollback)                                                          | Rollback workflow to a previous version                                                                                                                                                                                                                                                      |
| `POST`   | [/v1/workflows/&#123;id&#125;/run](/api/reference/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/&#123;id&#125;/runs](/api/reference/get-v1-workflows-id-runs)                                                                   | List all runs for a specific workflow                                                                                                                                                                                                                                                        |
| `GET`    | [/v1/workflows/&#123;id&#125;/runs/count](/api/reference/get-v1-workflows-id-runs-count)                                                       | Count runs for a specific workflow, grouped by status                                                                                                                                                                                                                                        |
| `GET`    | [/v1/workflows/&#123;id&#125;/runs/stream](/api/reference/get-v1-workflows-id-runs-stream)                                                     | Stream workflow run events                                                                                                                                                                                                                                                                   |
| `GET`    | [/v1/workflows/&#123;id&#125;/schedule](/api/reference/get-v1-workflows-id-schedule)                                                           | Get next run time for a scheduled workflow                                                                                                                                                                                                                                                   |
| `GET`    | [/v1/workflows/&#123;id&#125;/trigger-aggregates](/api/reference/get-v1-workflows-id-trigger-aggregates)                                       | Per-trigger run aggregates \(last fired, run count, success / failure breakdown, next fire preview\) for a workflow                                                                                                                                                                          |
| `GET`    | [/v1/workflows/&#123;id&#125;/trigger-info](/api/reference/get-v1-workflows-id-trigger-info)                                                   | Get trigger info \(e.g. Pipedream email address\) for a workflow                                                                                                                                                                                                                             |
| `PATCH`  | [/v1/workflows/&#123;id&#125;/ui-metadata](/api/reference/patch-v1-workflows-id-ui-metadata)                                                   | Update workflow UI metadata \(node positions\) in-place                                                                                                                                                                                                                                      |
| `GET`    | [/v1/workflows/&#123;id&#125;/versions](/api/reference/get-v1-workflows-id-versions)                                                           | List all versions of a workflow                                                                                                                                                                                                                                                              |
| `GET`    | [/v1/workflows/&#123;id&#125;/versions/&#123;versionNumber&#125;](/api/reference/get-v1-workflows-id-versions-version-number-)                 | Get a specific version of a workflow by version number                                                                                                                                                                                                                                       |
| `GET`    | [/v1/workflows/&#123;id&#125;/versions/count](/api/reference/get-v1-workflows-id-versions-count)                                               | Count total versions for a specific workflow                                                                                                                                                                                                                                                 |
| `PUT`    | [/v1/workflows/&#123;id&#125;/visibility](/api/reference/put-v1-workflows-id-visibility)                                                       | Update workflow visibility level                                                                                                                                                                                                                                                             |
| `DELETE` | [/v1/workflows/&#123;id&#125;/widget](/api/reference/delete-v1-workflows-id-widget)                                                            | Disable public widget for a workflow                                                                                                                                                                                                                                                         |
| `POST`   | [/v1/workflows/&#123;id&#125;/widget](/api/reference/post-v1-workflows-id-widget)                                                              | Enable public widget for a workflow                                                                                                                                                                                                                                                          |
| `GET`    | [/v1/workflows/&#123;workflowId&#125;/variables](/api/reference/get-v1-workflows-workflow-id-variables)                                        | List workflow variables                                                                                                                                                                                                                                                                      |
| `DELETE` | [/v1/workflows/&#123;workflowId&#125;/variables/&#123;name&#125;](/api/reference/delete-v1-workflows-workflow-id-variables-name-)              | Delete workflow variable                                                                                                                                                                                                                                                                     |
| `PUT`    | [/v1/workflows/&#123;workflowId&#125;/variables/&#123;name&#125;](/api/reference/put-v1-workflows-workflow-id-variables-name-)                 | Create or update workflow variable definition                                                                                                                                                                                                                                                |
| `GET`    | [/v1/workflows/&#123;workflowId&#125;/variables/&#123;name&#125;/history](/api/reference/get-v1-workflows-workflow-id-variables-name-history)  | Workflow variable write history                                                                                                                                                                                                                                                              |
| `POST`   | [/v1/workflows/&#123;workflowId&#125;/variables/&#123;name&#125;/reset](/api/reference/post-v1-workflows-workflow-id-variables-name-reset)     | Reset workflow variable to default                                                                                                                                                                                                                                                           |
| `POST`   | [/v1/workflows/&#123;workflowId&#125;/variables/&#123;name&#125;/value](/api/reference/post-v1-workflows-workflow-id-variables-name-value)     | Manually set workflow variable value                                                                                                                                                                                                                                                         |
| `POST`   | [/v1/workflows/analyze-funds](/api/reference/post-v1-workflows-analyze-funds)                                                                  | Analyze the fund requirements of an inline workflow definition without saving or executing it. Same response shape as the workflow-scoped variant, with 'workflowId' empty. Read-only — does not consume CU.                                                                                 |
| `POST`   | [/v1/workflows/batch-meta](/api/reference/post-v1-workflows-batch-meta)                                                                        | Batch workflow metadata                                                                                                                                                                                                                                                                      |
| `POST`   | [/v1/workflows/batch-stats](/api/reference/post-v1-workflows-batch-stats)                                                                      | Batch workflow stats                                                                                                                                                                                                                                                                         |
| `GET`    | [/v1/workflows/counts](/api/reference/get-v1-workflows-counts)                                                                                 | Get workflow counts grouped by status \(filter-aware\).                                                                                                                                                                                                                                      |
| `GET`    | [/v1/workflows/owner-counts](/api/reference/get-v1-workflows-owner-counts)                                                                     | Get workflow counts grouped by owner scope \(yours/org/public\).                                                                                                                                                                                                                             |
| `POST`   | [/v1/workflows/validate](/api/reference/post-v1-workflows-validate)                                                                            | Validate a workflow definition without saving                                                                                                                                                                                                                                                |