Sessions

PreviousAPI Reference NextScrape

Last updated 3 months ago

Stop a session

put

Authorizations

Path parameters

idstringrequired

Responses

application/json

objectoptional

application/json

put

PUT /api/session/{id}/stop HTTP/1.1
Host: app.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true
}

Get list of sessions

get

Authorizations

Query parameters

pagenumberoptionalDefault: 1

statusstring · enumoptionalAvailable options:

Responses

application/json

objectoptional

application/json

get

GET /api/sessions HTTP/1.1
Host: app.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "sessions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "teamId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "active",
      "startTime": "text",
      "endTime": "text",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "totalCount": 100,
  "page": 1,
  "pageSize": 10
}

Get session by ID

get

Authorizations

Path parameters

idstringrequired

Responses

application/json

all ofoptional

application/json

get

GET /api/session/{id} HTTP/1.1
Host: app.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "teamId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "active",
  "startTime": "text",
  "endTime": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "sessionUrl": "text",
  "liveUrl": "text",
  "token": "text",
  "wsEndpoint": "text"
}

Create new session

post

Authorizations

Body

useStealthbooleanoptionalDefault: false

useProxybooleanoptionalDefault: false

proxyServerstringoptional

proxyServerPasswordstringoptional

proxyServerUsernamestringoptional

proxyCountrystring · enumoptionalDefault: USAvailable options:

proxyStatestring · enum | nullableoptional

Optional state code for proxies to US states. Is mutually exclusive with proxyCity. Takes in two letter state code.

Available options:

proxyCitystring | nullableoptional

Desired Country. Is mutually exclusive with proxyState. Some cities might not be supported, so before using a new city, we recommend trying it out

Example: new york

operatingSystemsstring · enum[]optional

devicestring · enum[]optional

platformstring · enum[]optional

localesstring · enum[]optionalDefault: ["en"]

screenobjectoptional

solveCaptchasbooleanoptionalDefault: false

adblockbooleanoptionalDefault: false

trackersbooleanoptionalDefault: false

annoyancesbooleanoptionalDefault: false

enableWebRecordingbooleanoptional

profileobjectoptional

acceptCookiesbooleanoptional

extensionIdsstring · uuid[]optionalDefault: []

urlBlockliststring[]optionalDefault: []

browserArgsstring[]optionalDefault: []

imageCaptchaParamsobject[] | nullableoptional

Responses

application/json

all ofoptional

post

POST /api/session HTTP/1.1
Host: app.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 635

{
  "useStealth": true,
  "useProxy": true,
  "proxyServer": "text",
  "proxyServerPassword": "text",
  "proxyServerUsername": "text",
  "proxyCountry": "US",
  "proxyState": "AL",
  "proxyCity": "new york",
  "operatingSystems": [
    "windows"
  ],
  "device": [
    "desktop"
  ],
  "platform": [
    "chrome"
  ],
  "locales": [
    "en"
  ],
  "screen": {
    "width": 1,
    "height": 1
  },
  "solveCaptchas": true,
  "adblock": true,
  "trackers": true,
  "annoyances": true,
  "enableWebRecording": true,
  "profile": {
    "id": "text",
    "persistChanges": true
  },
  "acceptCookies": true,
  "extensionIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "urlBlocklist": [
    "text"
  ],
  "browserArgs": [
    "text"
  ],
  "imageCaptchaParams": [
    {
      "imageSelector": "text",
      "inputSelector": "text"
    }
  ]
}

200

Session created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "teamId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "active",
  "startTime": "text",
  "endTime": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "sessionUrl": "text",
  "liveUrl": "text",
  "token": "text",
  "wsEndpoint": "text"
}