v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-109044.3 KB

Create Browser Session

Create a new hosted browser session.

post/v1/browser/session

Request body

type'hosted'

Use hosted Driver infrastructure for the session.

countrystring

Start a session in a specific country using its 2-letter ISO code. Optional.

nodeIdstring

Create the hosted session on a specific previously used hosted node. Optional. Overrides country.

durationinteger

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).

windowSizestring

The window size for the browser session in the format WIDTHxHEIGHT (e.g., 1920x1080). Optional.

proxyUrlstring

SOCKS5 proxy URL for the session. Optional. Requires hosted sessions and cannot be used with nodeId.

fastboolean

Attempt faster startup when the request is eligible. Optional.

captchaSolverboolean

Enable the built-in CAPTCHA solver for the session. Optional. Default is false.

extensionIdsstring[]

Chrome extension IDs to load into the browser session. Optional. Requires extension access for your account.

Example request

{
  "type": "hosted",
  "country": "US",
  "nodeId": "node-id-from-servedBy",
  "duration": 600,
  "windowSize": "1920x1080",
  "proxyUrl": "socks5://user:pass@proxy.example.com:1080",
  "profile": {
    "name": "example-session-1",
    "persist": true
  },
  "fast": true,
  "captchaSolver": true,
  "extensionIds": [
    "abc123def456"
  ]
}

Response

Successfully created a browser session.

sessionIdstring required

The ID of the created browser session.

status'starting' | 'active' | 'completed' | 'error' required

The status of the session.

servedBystring required

The node ID that is serving this session.

createdAtstring required

The ISO 8601 timestamp when the session was created.

stoppedAtstring nullable required

The ISO 8601 timestamp when the session was stopped, or null if it is still active.

cdpUrlstring uri nullable required

The URL to access the Chrome DevTools Protocol for this session, or null if not available.

notestring nullable required

An optional note attached to the session, or null if not set.