Update Browser Session | Browser Use Cloud Docs

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)

1	import requests
2
3	url = "https://api.browser-use.com/api/v2/browsers/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	"timeoutAt": "2024-01-15T09:30:00Z",
5	"startedAt": "2024-01-15T09:30:00Z",
6	"liveUrl": "string",
7	"cdpUrl": "string",
8	"finishedAt": "2024-01-15T09:30:00Z"
9	}

Authentication

Path Parameters

Request

Response

Errors