Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Send your API key in the Authorization header as Bearer <API_KEY>.

Body

application/json

Request body used to start a new task from a workflow.

​
workflow_id
string
required

The workflow ID to run.

Minimum string length: 1
Example:

"wf_123456789"

​
input_parameters
object[]

Input parameters for this run.

Example:
​
save_browser_data
boolean

If true, the response will include a profile_id. You can reuse that profile_id in later runs to reuse browser data (e.g., cookies).

Example:

true

​
profile_id
string

Reuse browser data from a previous run (e.g., cookies) by providing a profile_id.

Example:

"profile_abc123"

​
open_incognito_mode
boolean
deprecated

Deprecated. No longer required.

Example:

false

​
callback_url
string

Optional. HTTP/HTTPS URL to receive a POST notification when the task finishes, fails, or is canceled. Maximum length: 2048 characters. Must be publicly reachable (no private/local addresses).

Maximum string length: 2048
Example:

"https://your-server.com/webhooks/workflow-callback"

​
status_change_callback_url
string

Optional. HTTP/HTTPS URL to receive a POST notification whenever the task status changes (e.g., running, paused, finished, canceled, failed). Maximum length: 2048 characters. Must be publicly reachable (no private/local addresses).

Maximum string length: 2048
Example:

"https://your-server.com/webhooks/task-status-change-callback"

Response

OK

Response returned after successfully creating a task.

​
id
string
required

The unique task_id. Use it to poll status/results or to stop/resume the task.

Example:

"task_123456789"

​
profile_id
string

Returned only when save_browser_data is true. Use it to reuse browser data (e.g., cookies) in later runs.

Example:

"profile_abc123"