API Referencev2 API (Current)Browsers

Create Browser Session

Create a new browser session.

Headers

X-Browser-Use-API-KeystringRequired

Request

This endpoint expects an object.
profileIdstring or nullOptionalformat: "uuid"
The ID of the profile to use for the session
proxyCountryCodeenum or nullOptional
Country code for proxy location.

Response

Successful Response
idstringformat: "uuid"
Unique identifier for the session
statusenum

Current status of the session (active/stopped)

Allowed values:
startedAtstringformat: "date-time"
Timestamp when the session was created and started
liveUrlstring or null

URL where the browser can be viewed live in real-time

cdpUrlstring or null
Chrome DevTools Protocol URL for browser automation
finishedAtstring or nullformat: "date-time"

Timestamp when the session was stopped (None if still active)

Errors