Skip to main content
POST
{baseUrl}
/
api
/
flow
/
workflows
/
{workflow_uuid}
/
execute
/
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "running",
  "started_at": "2023-11-07T05:31:56Z"
}
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

​
workflow_uuid
string
required
UUID of the workflow to execute.

​
Query parameters

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

​
Body parameters

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

​
Example body

{
  "trigger_type": "api",
  "inputs": {
    "company": "Pharen",
    "priority": "high"
  }
}

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>