Skip to main content
cURL
curl --request POST \
  --url https://api.simplex.sh/run_workflow \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form workflow_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form 'metadata=<string>' \
  --form 'webhook_url=<string>' \
  --form 'variables={"username": "john_doe", "product_id": "12345", "quantity": 2}'
{
  "succeeded": true,
  "message": "<string>",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vnc_url": "<string>"
}
Runs a saved workflow.

Authorizations

​
X-API-Key
string
header
required

Simplex API Key

Body

multipart/form-data
​
workflow_id
string<uuid>
required

The ID of the workflow to run.

​
metadata
string

JSON string containing metadata for the workflow. This metadata is passed back to you in the webhook response.

​
webhook_url
string

Optional webhook URL to test workflow changes on. Often an ngrok URL of a local version of your application.

​
variables
string

JSON string containing variables to pass to the workflow.

Example:

"{\"username\": \"john_doe\", \"product_id\": \"12345\", \"quantity\": 2}"

​
files
file[]

Optional list of files to upload for workflows that contain file upload actions.

Response

Run workflow response

​
succeeded
boolean
required

Whether the workflow code executed successfully.

​
message
string
required

Success or error message about the workflow execution.

​
session_id
string<uuid>
required

The session ID for the workflow.

​
vnc_url
string
required

The VNC URL for viewing the workflow session. You can put this in an iframe to whitelabel Simplex's sessions.