Skip to main content
POST
/
tasks
curl --request POST \
  --url https://browser.ai/api/v1/tasks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instructions": [
    {
      "action": "Open amazon.com and search for AirPods"
    }
  ],
  "geoLocation": {
    "country": "US"
  },
  "project": "Project_1",
  "type": "crawler_automation"
}
'
{
  "executionId": "<string>",
  "scriptType": "<string>",
  "status": "<string>",
  "geoLocation": {
    "country": "<string>",
    "city": "<string>",
    "zipcode": "<string>"
  },
  "started": "2023-11-07T05:31:56Z",
  "estimatedCompletion": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.browser.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Insert API token, use the format: apikey <API-TOKEN>.

Body

application/json
​
instructions
object[]
required

List of actions to perform. For 'crawler_automation', use natural language. For 'script_automation', use TypeScript code.

​
geoLocation
object
required
​
project
string
required
​
type
enum<string>
required

Execution engine: 'crawler_automation' for natural language, 'script_automation' for code.

Available options:
crawler_automation,
script_automation
​
inspect
boolean

Response

Task created successfully

​
executionId
string
​
scriptType
string
​
status
string
​
geoLocation
object
​
started
string<date-time> | null
​
estimatedCompletion
string<date-time> | null