API ReferenceAPI v2Sessions

Get Session

Get detailed session information including status, URLs, and task details.

Authentication

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

Path parameters

session_idstringRequiredformat: "uuid"

Response

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

Current status of the session (active/stopped)

Allowed values:
startedAtdatetime
Timestamp when the session was created and started
taskslist of objects
List of tasks associated with this session
liveUrlstring or null

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

finishedAtdatetime or null

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

publicShareUrlstring or null
Optional URL to access the public share of the session
persistMemoryboolean or nullDefaults to true
Whether tasks in this session share memory and history with each other
keepAliveboolean or nullDefaults to true
Whether the browser session stays alive after tasks complete
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

Errors