api-v-2-workflow-controller

Start a new task execution

Initiates a new task with specified parameters and returns the task identifier.

post/v2/workflow/run-task

Request

  • Base URL: https://api.browseract.com
  • URL: https://api.browseract.com/v2/workflow/run-task
  • Auth: HTTP bearer

Request body

workflow_idstring

Which workflow you need to run.

save_browser_databoolean

If set to true, a profile_id will be returned upon successful task initiation. This ID can be used to reuse browser data generated during this task.

profile_idstring

Use a previously returned profile_id to reuse browser data (e.g., cookies) from an earlier task.

open_incognito_modeboolean
callback_urlstring

Optional. HTTP/HTTPS URL to receive task completion notifications. The system will send a POST request with task results when the task finishes, fails, or is canceled. Maximum length: 2048 characters. Cannot point to private/local addresses.

status_change_callback_urlstring

Optional. HTTP/HTTPS URL to receive task status change notifications. The system will send a POST request with task results when the task's status change, such as running, finished, canceled, paused, failed. Maximum length: 2048 characters. Cannot point to private/local addresses.

Example request

{
  "callback_url": "https://your-server.com/webhooks/workflow-callback",
  "status_change_callback_url": "https://your-server.com/webhooks/task-status-change-callback"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.