Skip to main content
GET
/
api
/
sessions
JavaScript
import { Hyperbrowser } from '@hyperbrowser/sdk';

const client = new Hyperbrowser({ apiKey: 'your-api-key' });

await client.sessions.list({
  status: 'active'
});
{
  "sessions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "active",
      "startTime": "<string>",
      "endTime": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "launchState": {
        "useUltraStealth": true,
        "useStealth": true,
        "useProxy": true,
        "solveCaptchas": true,
        "adblock": true,
        "trackers": true,
        "annoyances": true,
        "screen": {
          "width": 1280,
          "height": 720
        },
        "enableWebRecording": true,
        "enableVideoWebRecording": true,
        "enableLogCapture": true,
        "acceptCookies": true,
        "profile": {
          "id": "<string>",
          "persistChanges": true
        },
        "staticIpId": "<string>",
        "saveDownloads": true,
        "enableWindowManager": true,
        "enableWindowManagerTaskbar": true,
        "viewOnlyLiveView": true,
        "disablePasswordManager": true,
        "enableAlwaysOpenPdfExternally": true
      },
      "creditsUsed": 123
    }
  ],
  "totalCount": 100,
  "page": 1,
  "pageSize": 10
}

Authorizations

x-api-key
string
header
required

Query Parameters

page
number
default:1
status
enum<string>
Available options:
active,
closed,
error

Response

List of sessions

sessions
object[]
totalCount
number
Example:

100

page
number
Example:

1

pageSize
number
Example:

10