PATCH
/
sessions
/
{session_id}
JavaScript
import BrowserUse from 'browser-use-sdk';

const client = new BrowserUse({
  apiKey: 'My API Key',
});

const sessionView = await client.sessions.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { action: 'stop' });

console.log(sessionView.id);
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "active",
  "liveUrl": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "finishedAt": "2023-11-07T05:31:56Z",
  "tasks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "llm": "<string>",
      "task": "<string>",
      "status": "started",
      "startedAt": "2023-11-07T05:31:56Z",
      "finishedAt": "2023-11-07T05:31:56Z",
      "metadata": {},
      "isScheduled": true,
      "doneOutput": "<string>",
      "browserUseVersion": "<string>",
      "isSuccess": true
    }
  ],
  "recordUrl": "<string>",
  "publicShareUrl": "<string>"
}

Authorizations

​
X-Browser-Use-API-Key
string
header
required

Path Parameters

​
session_id
string<uuid>
required

Body

application/json

Request model for updating session state

Attributes: action: The action to perform on the session

Response

200
application/json

Successful Response

View model for representing a (browser) session with its associated tasks.

Attributes: id: Unique identifier for the session. status: Current status of the session (active/stopped). live_url: URL where the browser can be viewed live in real-time. started_at: Timestamp when the session was created and started. finished_at: Timestamp when the session was stopped (None if still active). tasks: Optional list of tasks associated with this session. record_url: URL to access the recorded session playback. public_share_url: Optional URL to access the public share of the session.