SupportDashboard

Sessions

Create new session

post
Authorizations
Body
useStealthbooleanOptionalDefault: false
useProxybooleanOptionalDefault: false
proxyServerstringOptional
proxyServerPasswordstringOptional
proxyServerUsernamestringOptional
proxyCountrystring · enumOptionalPossible values:
proxyStatestring · enum | nullableOptional

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

Possible values:
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
solveCaptchasbooleanOptionalDefault: false
adblockbooleanOptionalDefault: false
trackersbooleanOptionalDefault: false
annoyancesbooleanOptionalDefault: false
enableWebRecordingbooleanOptional
enableVideoWebRecordingbooleanOptional

enableWebRecording must also be true for this to work

Default: false
acceptCookiesbooleanOptional
extensionIdsstring · uuid[]OptionalDefault: []
urlBlockliststring[]OptionalDefault: []
browserArgsstring[]OptionalDefault: []
timeoutMinutesnumber · min: 1 · max: 720Optional
Responses
200
Session created
application/json
Responseall of
post
POST /api/session HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 697

{
  "useStealth": false,
  "useProxy": false,
  "proxyServer": "text",
  "proxyServerPassword": "text",
  "proxyServerUsername": "text",
  "proxyCountry": "AD",
  "proxyState": "AL",
  "proxyCity": "new york",
  "operatingSystems": [
    "windows"
  ],
  "device": [
    "desktop"
  ],
  "platform": [
    "chrome"
  ],
  "locales": [
    "aa"
  ],
  "screen": {
    "width": 1280,
    "height": 720
  },
  "solveCaptchas": false,
  "adblock": false,
  "trackers": false,
  "annoyances": false,
  "enableWebRecording": true,
  "enableVideoWebRecording": false,
  "profile": {
    "id": "text",
    "persistChanges": true
  },
  "acceptCookies": true,
  "extensionIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "urlBlocklist": [
    "text"
  ],
  "browserArgs": [
    "text"
  ],
  "imageCaptchaParams": [
    {
      "imageSelector": "text",
      "inputSelector": "text"
    }
  ],
  "timeoutMinutes": 1
}
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"
}

Get session by ID

get
Authorizations
Path parameters
idstringRequired
Responses
200
Session details
application/json
Responseall of
get
GET /api/session/{id} HTTP/1.1
Host: api.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"
}

Stop a session

put
Authorizations
Path parameters
idstringRequired
Responses
200
Session stopped successfully
application/json
put
PUT /api/session/{id}/stop HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true
}

Get list of sessions

get
Authorizations
Query parameters
pagenumberOptionalDefault: 1
statusstring · enumOptionalPossible values:
Responses
200
List of sessions
application/json
get
GET /api/sessions HTTP/1.1
Host: api.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
}
PreviousAPI ReferenceNextScrape

Last updated