Skip to main content
POST
browser.session.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ttlSeconds
integer
default:300

How long the session stays alive, 60 to 900 seconds. The whole time-to-live is billed at create, even if the session is closed earlier. Default 300.

Required range: 60 <= x <= 900

Response

The result

status
string
required

The session is running (it may still be starting up).

Allowed value: "running"
ttlSeconds
integer
required

How long the session lives from now, in seconds; the whole time-to-live is billed.

Required range: -9007199254740991 <= x <= 9007199254740991
ref
string

Reference to what this call created. Pass it as ref to browser.session.close, browser.sessions.list, browser.page.navigate, browser.page.read, browser.page.screenshot, browser.page.click, browser.page.type or browser.script.run.