Update Session | Browser Use Cloud Docs

1 import requests 2 3 url = "https://api.browser-use.com/api/v2/sessions/session_id" 4 5 payload = { "action": "stop" } 6 headers = { 7 "X-Browser-Use-API-Key": "<apiKey>", 8 "Content-Type": "application/json" 9 } 10 11 response = requests.patch(url, json=payload, headers=headers) 12 13 print(response.json())

1 { 2 "id": "string", 3 "status": "active", 4 "startedAt": "2024-01-15T09:30:00Z", 5 "tasks": [ 6 { 7 "id": "string", 8 "sessionId": "string", 9 "llm": "string", 10 "task": "string", 11 "status": "created", 12 "createdAt": "2024-01-15T09:30:00Z", 13 "startedAt": "2024-01-15T09:30:00Z", 14 "finishedAt": "2024-01-15T09:30:00Z", 15 "metadata": {}, 16 "output": "string", 17 "browserUseVersion": "string", 18 "isSuccess": true, 19 "judgement": "string", 20 "judgeVerdict": true 21 } 22 ], 23 "liveUrl": "string", 24 "finishedAt": "2024-01-15T09:30:00Z", 25 "publicShareUrl": "string" 26 }

Stop a session and all its running tasks.

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:

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

Authentication

Path Parameters

Request

Response

Errors