API ReferenceAPI v2Browsers

Update Browser Session

Stop a browser session.

Refund: When you stop a session, unused time is automatically refunded. If the session ran for less than 1 hour, you’ll receive a proportional refund. Billing is ceil to the nearest minute (minimum 1 minute).

Authentication

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

Path parameters

session_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
actionenumRequired
The action to perform on the session
Allowed values:

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)

proxyUsedMbstring or nullformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"Defaults to 0
Amount of proxy data used in MB
proxyCoststring or nullformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"Defaults to 0
Cost of proxy usage in USD
browserCoststring or nullformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"Defaults to 0
Cost of browser session hosting in USD

Errors