POST
/
browse
{
  "taskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "goal": "<string>",
  "startUrl": "<string>",
  "revision": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "WAITING",
  "outputType": "string",
  "output": "<string>",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "steps": [
    {
      "at": "2023-11-07T05:31:56Z",
      "url": "<string>",
      "screenshot": "<string>",
      "action": {}
    }
  ],
  "country": "<string>",
  "evalIds": [
    "<string>"
  ],
  "interactionMode": "default"
}

Query Parameters

​
consume_enabled
boolean
default:false
​
name
string | null

Body

application/json

Specifications for the browsing task

​
goal
string
required

The goal or objective of the browsing task

​
startUrl
string
required

The URL where the browsing task should begin

​
outputType
enum<string>

The type of output expected from the task, Optional (by default, the task will output a string)

Available options:
string,
url,
list[url]
​
completionCallbackUrl
string | null

An optional URL to be called when the task is completed.

​
country
string | null

The 2-letter country code where the task's traffic should be routed through, (eg IE for Ireland, FR for France)

​
interactionMode
enum<string>

The agent interaction mode (default, everything_interactable...)

Available options:
default,
everything_interactable,
vision_only

Response

Successful Response

​
taskId
string<uuid>
required
​
goal
string
required
​
startUrl
string
required
​
revision
string<uuid>
required
​
status
enum<string>
required
Available options:
WAITING,
RUNNING,
COMPLETED,
FAILED,
CANCELLED
​
outputType
enum<string>
required
Available options:
string,
url,
list[url]
​
output
required
​
errors
APITaskError · object[] | null
required
​
steps
APITaskStep · object[]
required
​
country
string | null
required
​
evalIds
string[] | null
required
​
interactionMode
enum<string> | null
Available options:
default,
everything_interactable,
vision_only