Skip to main content
POST
Run an official workflow template (create a task)

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 an official workflow template.

workflow_template_id
string
required

The official workflow template ID to run.

Example:

"tpl_123456789"

proxyRegion
string

Optional. Proxy region code. Defaults to US.

Example:

"US"

input_parameters
object[]

Input parameters for this run.

Example:
callback_url
string

Optional. See RunWorkflowTaskRequest.callback_url.

Maximum string length: 2048
Example:

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

status_change_callback_url
string

Optional. See RunWorkflowTaskRequest.status_change_callback_url.

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"