API Referencev2 API (Current)Browsers

Create Browser Session

Create a new browser session. **Pricing:** Browser sessions are charged at $0.05 per hour. The full hourly rate is charged upfront when the session starts. When you stop the session, any unused time is automatically refunded proportionally. Billing is rounded to the nearest minute (minimum 1 minute). For example, if you stop a session after 30 minutes, you'll be refunded $0.025. **Session Limits:** - Free users (without active subscription): Maximum 15 minutes per session - Paid subscribers: Up to 4 hours per session

Authentication

X-Browser-Use-API-Keystring
API Key authentication via header

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.
timeoutintegerOptional1-240Defaults to 15

The timeout for the session in minutes. Free users are limited to 15 minutes, paid users can use up to 240 minutes (4 hours).

Response

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

Current status of the session (active/stopped)

Allowed values:
timeoutAtdatetime
Timestamp when the session will timeout
startedAtdatetime
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
finishedAtdatetime or null

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

Errors