POST
/
api
/
sessions

Authorizations

anchor-api-key
string
header
required

API key passed in the header

Body

application/json
adblock_config
object

Configuration options for ad-blocking.

captcha_config
object

Configuration options for captcha-solving.

headless
boolean

Whether browser should be headless or headfull.

proxy_config
object

Configuration options for proxy usage.

recording
object

Should the session be recorded.

profile
object

Options for managing and persisting session profiles.

viewport
object

Configuration for the browser's viewport size.

timeout
integer

Maximum amount of time (in minutes) for the browser to run, before terminating. Defaults to -1, which disables the global timeout mechanism.

idle_timeout
integer

The amount of time (in minutes) the session waits for new connections after all others are closed before stopping. Defaults to 1. Setting it to -1 let the browser session continue forever [CAUTION - Keep track of long living sessions and manually kill them].

Response

200
application/json
Successfully returned a browser object
page_id
string

Unique identifier for the browser page

id
string

Unique identifier for the browser instance

session_url
string

The cdp based live view embedding url

live_view_url
string

The headfull chrome live view url, only available for headfull sessions