Create Session

Create a new session with a new task.

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.
startUrlstring or nullOptional
URL to navigate to when the session starts.

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
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)

Errors