ANanchorbrowser
Tasks

Run a Task

Changed on

Triggers execution of a task by ID using the non-deprecated Tasks endpoints.

post/v2/tasks/{taskId}/run

Request

  • Base URL
    https://api.anchorbrowser.io
  • Auth
    API key in header anchor-api-key

Path parameters

taskIdstring required

The ID of the task to run

Request body

input_paramsobject required

Key-value pairs of input parameters for the task

identity_idstring

Optional identity ID to use for the task

session_idstring

Optional session ID to run the task in

cleanup_sessionsboolean

Whether to clean up sessions after execution (default: true)

identity_skip_validationboolean

When true (default), skip profile validation for active identities and reuse the saved browser profile. Set to false to validate the profile and re-authenticate if it is no longer signed in. Pending identities still authenticate on first use.

syncboolean

Wait for the task to complete before returning. Defaults to false.

Response

Task run started successfully

run_idstring required

The ID of the task run

status'queued' | 'running' | 'success' | 'failure' | 'timeout' | 'cancelled' required

Current task run status

resultobject

Task output when available

errorstring

Error message when the run fails

session_idstring

Session ID used for this task run

Changes