POST
/
v1
/
workflowRuns
/
{publicId}
/
start
Start workflow run
curl --request POST \
  --url https://app.enzo.health/api/v1/workflowRuns/{publicId}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "prefilledVariables": {
    "Input File": "https://example.com/file.txt"
  },
  "workflowExecutionId": "<string>"
}'
{
  "sessionId": "<string>",
  "workflowExecutionId": "<string>",
  "workflow": {
    "id": "<string>"
  },
  "logs": [
    {
      "status": "<string>",
      "description": "<string>",
      "details": "<any>"
    }
  ],
  "progress": 123,
  "event": {
    "id": "<string>",
    "name": "<string>",
    "payload": "<any>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
publicId
string
required

Where to find my workflow's public ID?

Body

application/json
​
prefilledVariables
object
Example:
{
  "Input File": "https://example.com/file.txt"
}
​
workflowExecutionId
string

Provide it if you'd like to overwrite an existing result.

Response

Successful response

​
sessionId
string
required

To save and use for /continue requests.

​
workflow
object
required
​
workflowExecutionId
string
​
logs
object[]

Logs that were saved during the last execution

​
progress
number

If enabled, this field will return a number between 0 and 100 indicating the current progress based on the longest remaining path of the workflow run.

​
event
object