Zum Hauptinhalt springen
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"
}
Fuhrt einen veroffentlichten Workflow aus und gibt Fortschrittsinformationen zuruck. Streaming ist nur moglich, wenn der Key Streaming-Zugriff erlaubt.
Erforderlicher API-Key-Scope: workflows:run.

​
Path-Parameter

​
workflow_uuid
string
erforderlich
UUID des Workflows.

​
Query-Parameter

​
team_id
string
erforderlich
Team-UUID, zu der der Workflow gehort.
​
stream
boolean
Setze true, um eine Streaming-Antwort anzufordern. Der Key muss Streaming erlauben.

​
Body-Parameter

​
inputs
object
Werte fur Workflow-Input-Variablen.
​
trigger_type
string
Trigger-Bezeichnung fur den Lauf. Standard ist manual.

​
Beispiel-Body

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

Autorisierungen

​
Authorization
string
header
Standard:phk_your_api_key
erforderlich

Paste your Pharen API key without the Bearer prefix.

Pfadparameter

​
workflow_uuid
string<uuid>
erforderlich

Workflow UUID.

Body

application/json
​
input
object

JSON input passed to the workflow run.

Antwort

Workflow execution started or completed.

​
id
string<uuid>
​
workflow_id
string<uuid>
​
status
string
Beispiel:

"running"

​
started_at
string<date-time>