GET
/
sessions
JavaScript
import BrowserUse from 'browser-use-sdk';

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

const sessions = await client.sessions.list();

console.log(sessions.items);
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "active",
      "liveUrl": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "finishedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "totalItems": 123,
  "pageNumber": 123,
  "pageSize": 123
}

Authorizations

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

Query Parameters

pageSize
integer
default:10
Required range: 1 <= x <= 100
pageNumber
integer
default:1
Required range: x >= 1
filterBy
enum<string> | null

Enumeration of possible (browser) session states

Attributes: ACTIVE: Session is currently active and running (browser is running) STOPPED: Session has been stopped and is no longer active (browser is stopped)

Available options:
active,
stopped

Response

200
application/json

Successful Response

Response model for paginated session list requests

Attributes: items: List of session views for the current page