Create a remote browser session with screen, proxy, rrweb, and profile options.

API

Operation: POST /browser/sessions OpenAPI Source: api-reference/openapi.json

Request Body

FieldTypeRequired
namestringyes
workspaceIdstringno
screenWidthnumberno
screenHeightnumberno
enableStealthbooleanno
enableAdblockbooleanno
profileModestringno
proxyUrlstringno
proxyUsernamestringno
proxyPasswordstringno
proxyProviderstringno
proxyTypestringno
enableCaptchaSolverbooleanno
captchaProviderstringno
captchaApiKeystringno
enableRrwebbooleanno
enableLoggerbooleanno
cpuMillisnumberno
memoryMbnumberno
maxLifetimeSecondsnumberno
gpuTypestringno
profileIdstringno
geonodeProxyobjectno

Responses

StatusDescription
201Browser session created successfully
400Bad request
401Unauthorized

CLI

Supported via CLI.
agv browser create --screen-width 1920 --screen-height 1080 --stealth
Notes:
  • The browser CLI also supports profile, proxy, captcha, rrweb, and open/wait controls.

Python SDK

Supported via Python SDK.
client.browser.create(screen_width=1920, screen_height=1080, stealth=True)
Notes:
  • Use Client.browser.create() for programmatic session creation.