Create a session
Create a browser session and wait for CDP readiness. hosted, hosted_stealth, and hosted_privacy are hosted browsers; hosted_stealth applies the conservative stealth policy and hosted_privacy the aggressive one. Hosted Canadian sessions without an explicit proxy egress from Driver’s Canadian ISP network. Country defaults to US; omitted locale and proxy values are resolved coherently.
Authorizations
A workspace API key from Settings → API keys in the dashboard (https://app.driver.dev), sent as a bearer token.
Body
The ID of the node to create a session on. Optional. If not provided, a random node will be selected. If provided, it takes precedence over country and type.
"this-node-id"
Two-letter country code used for placement and locale coherence. Defaults to US unless a SOCKS5 URL is supplied with neither language nor timezone, in which case Driver derives the country from the proxy exit. A supplied country must match that resolved exit. Driver otherwise selects a plausible primary language and dominant regional timezone.
2"US"
Browser execution class. hosted is the native browser, hosted_stealth applies the conservative stealth policy, and hosted_privacy the aggressive one. Defaults to hosted.
hosted, hosted_stealth, hosted_privacy "hosted_privacy"
Initial URL opened by the browser after launch. Optional. Opened right after launch.
1"https://example.com"
Explicit SOCKS5 or SOCKS5H URL for the session. A SOCKS URL supplied without language or timezone is geolocated before launch; Driver derives or validates country and uses the exit timezone. When omitted, the session egresses from Driver's ISP network in the requested country. HTTP proxies are not supported. One of the workspace's dedicated IPs is named here as dedicated://, dedicated://any or dedicated://any~country-XX; Driver resolves it to the address's own SOCKS URL and takes the country and timezone from it.
"socks5://user:[email protected]:1080"
Outer browser-window size in WIDTHxHEIGHT format. Width must be 320–16384 and height 200–16384.
"1920x1040"
Virtual display size in WIDTHxHEIGHT format. Width must be 320–16384 and height 200–16384.
"1920x1080"
IANA timezone for the browser. It must be listed for the selected country. When omitted, Driver selects a dominant regional timezone and, where Driver runs a managed network there, routes the session through that region.
1 - 128"America/New_York"
BCP-47 browser language listed for the selected country. US sessions accept only en-US and omit both language launch fields so the browser uses its built-in en-US default. For other countries, Driver deterministically chooses the likely primary language the browser supports. Hosted sessions provision matching TTS when available; otherwise Web Speech is disabled for coherence.
2 - 64"en-US"
The duration of the browser session in seconds. Optional. Default is 3600 seconds (1 hour). Cannot be greater than 3600 seconds (1 hour). Cannot be less than 60 seconds (1 minute).
60 <= x <= 3600600
A named full browser profile. Persistent profiles are kept between sessions.
Whether to enable ad-blocking in the browser session. Optional. Default is false.
true
Whether to enable the built-in CAPTCHA solver for the session. Optional. Default is false.
true
Internal extension IDs returned by the extensions API. Requires account-level extension access.
Whether to run a browser validation check during session creation. Optional. Default is false.
false
An optional note to attach to the session. Maximum 256 characters.
256"Scraping product pages for client X"
Response
Successfully created a browser session.
The session id: an opaque string; do not validate its format.
The status of the session.
starting, active, completed, error The node ID that is serving this session.
The ISO 8601 timestamp when the session was created.
The ISO 8601 timestamp when the session was stopped, or null if it is still active.
The URL to access the Chrome DevTools Protocol for this session, or null if not available.
An optional note attached to the session, or null if not set.