API ReferenceSessions

Update Session

Stop a session and all its running tasks.

Path parameters

session_idstringRequiredformat: "uuid"

Headers

X-Browser-Use-API-KeystringRequired

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:
startedAtstringformat: "date-time"
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

finishedAtstring or nullformat: "date-time"

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

publicShareUrlstring or null
Optional URL to access the public share of the session

Errors