Skip to main content
POST
Error
Executes a published workflow and returns node-level progress information. Streaming responses are available only when the key was created with streaming access.
Required API key scope: workflows:run.

Path parameters

string
required
UUID of the workflow to execute.

Query parameters

string
required
Team UUID that owns the workflow.
boolean
Set to true to request a streaming response. The key must allow streaming.

Body parameters

object
Values for workflow input variables.
string
Trigger label for the run. Defaults to manual.
string
Locale hint used by nodes that produce localized output.

Example body

Authorizations

Authorization
string
header
default:phk_your_api_key
required

Paste your Pharen API key without the Bearer prefix.

Path Parameters

workflow_uuid
string<uuid>
required

Workflow UUID.

Body

application/json
input
object

JSON input passed to the workflow run.

Response

Workflow execution started or completed.

id
string<uuid>
workflow_id
string<uuid>
status
string
Example:

"running"

started_at
string<date-time>