Skip to main content
POST
/
v1
/
task
/
run
/
{taskName}
Run Task by Name
curl --request POST \
  --url https://api.anchorbrowser.io/v1/task/run/{taskName} \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '{}'
{
  "data": {
    "success": true,
    "async": true,
    "message": "<string>",
    "taskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "executionTime": 123,
    "output": "<string>",
    "error": "<string>",
    "executionResultId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

​
anchor-api-key
string
header
required

API key passed in the header

Path Parameters

​
taskName
string
required

The name of the task to run

Example:

"web-scraper"

Body

application/json
​
sessionId
string<uuid>

Optional existing browser session ID to use for task execution

​
async
boolean

Whether to run the task asynchronously

​
overrideBrowserConfiguration
object

Override browser configuration for this execution

​
inputs
object

Environment variables for task execution (keys must start with ANCHOR_)

​
cleanupSessions
boolean
default:true

Whether to cleanup browser sessions after task execution. Defaults to true.

Response

Task executed successfully

​
data
object