Skip to main content
GET
/
sessions
List Sessions
const options = {method: 'GET', headers: {'X-Browser-Use-API-Key': '<api-key>'}};

fetch('https://api.browser-use.com/api/v2/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "active",
      "startedAt": "2023-11-07T05:31:56Z",
      "persistMemory": true,
      "keepAlive": true,
      "liveUrl": "<string>",
      "finishedAt": "2023-11-07T05:31:56Z",
      "proxyUsedMb": "0",
      "proxyCost": "0"
    }
  ],
  "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 agent session states

Attributes: ACTIVE: Agent session is currently active and running STOPPED: Agent session has been stopped and is no longer active

Available options:
active,
stopped

Response

Successful Response

Response model for paginated session list requests.

​
items
SessionItemView · object[]
required

List of session views for the current page

​
totalItems
integer
required

Total number of items in the list

​
pageNumber
integer
required

Page number

​
pageSize
integer
required

Number of items per page