Autonomous API Reference

Browse

POST

Allows for browsing the web using detailed natural language commands.

The function supports multi-step command execution based on the CONTINUE status of the Agent.

Request

This endpoint expects an object.
cmd
stringRequired
A specific natural language instruction for the agent to execute
url
stringOptional
The URL to start or continue browsing from. (Default: google.com)
local
booleanOptional
Boolean flag to indicate if session to be run locally or in the cloud (Default: False). If set to true, the session will be run locally via your chrome extension. If set to false, the session will be run in the cloud.
session_id
stringOptional

Continues the session with session_id if provided.

max_steps
integerOptionalDefaults to 20
Maximum number of steps to execute. (Default: 20)
include_screenshot
booleanOptional
Boolean flag to include a screenshot of the final page. (Default: False)
temperature
doubleOptional
The temperature of model
agent_id
stringOptional
The agent id to use for the session.
mode
enumOptional
The mode you would like to use for the session. 'fast' or 'standard'
Allowed values: faststandard
use_proxy
booleanOptional
Boolean flag to use a proxy for the session (Default: False). Each Session gets a new Residential IP.

Response

This endpoint returns an object
message
string
The final message or result of the browsing session.
status
string

The final status of the browsing session. One of [“CONTINUE”, “ASK_USER”, “DONE”]

url
string
The current URL of the session.
screenshot
string
image url of the screenshot taken during the session.
session_id
string
The unique identifier for the session.
metadata
objectOptional
Additional metadata for the session