api reference

sessions.create

Speed: Reuses the same browser instance across multiple requests.
Persistence: Retains cookies and session data until explicitly destroyed.
Convenience: Reuses cookies and browser state across requests.

Start a persistent browser session that retains cookies and reduces repeated setup work across multi-step browser workflows.

Updated May 30, 2025

Start a persistent browser session that retains cookies, speeds up requests, and reduces repeated setup work across multi-step browser workflows.

A session remains active for 200 seconds after the last request. After that, it is automatically destroyed.

Parameters

Parameter	Type	Required	Description
`session`	string	No	Custom session ID. If not set, a random UUID is generated.
`proxy`	string	No	Use a custom proxy. Supports `http://`, `socks4://`, or `socks5://` with authentication. Example: `"http://username:[email protected]:8888"`. Default: built-in rotating proxies from random countries.
`whitelistedDomains`	array	No	Allow requests to specified external domains. Example: `["probot.io", "google.com"]`. Useful for loading assets from third-party domains.
`datacenter`	boolean	No	Set to `true` to use a datacenter IP instead of a residential IP. Datacenter IPs offer higher speed and stability, but lower anonymity.
`browser`	array	No	Define the browser type and version range. Options: `chrome`, `firefox`, `safari`. Example: `[{ "name": "chrome", "minVersion": 116, "maxVersion": 117 }]`.
`operatingSystem`	array	No	Specify OS options. Options: `windows`, `macos`, `linux`, `android`, `ios`. Example: `["windows", "linux"]`.
`device`	array	No	Choose device type. Options: `desktop`, `mobile`. Example: `["desktop", "mobile"]`.

json4 lines

json12 lines