Skip to main content
cURL
curl --request POST \
  --url https://api.simplex.sh/create_workflow_session \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "workflow_name": "<string>",
  "proxies": false,
  "session_data": "<string>",
  "timeout": 1200,
  "webhook_url": "<string>",
  "metadata": "<string>"
}'
{
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "livestream_url": "<string>",
  "connect_url": "<string>",
  "vnc_url": "<string>"
}
Creates a new workflow session.

Authorizations

​
X-API-Key
string
header
required

Simplex API Key

Body

application/json
​
workflow_name
string
required

The name of the workflow.

​
proxies
boolean
default:false

Whether to use proxies.

​
session_data
string

JSON string containing session data.

​
timeout
integer
default:1200

Timeout in seconds.

​
webhook_url
string<uri>

Webhook URL to notify on workflow events.

​
metadata
string

JSON string containing metadata.

Response

Create workflow session response

​
session_id
string<uuid>
required

The session ID.

​
workflow_id
string<uuid>
required

The workflow ID.

​
livestream_url
string

URL to view the live session.

​
connect_url
string

CDP connection URL.

​
vnc_url
string

VNC connection URL.

⌘I