HYhyperbrowser

Create new session

Changed on
post/api/session

Request

Request body

useUltraStealthboolean
useStealthboolean
useProxyboolean
proxyServerstring

Custom proxy server host.

proxyServerPasswordstring

Password for authenticating with the custom proxy server.

proxyServerUsernamestring

Username for authenticating with the custom proxy server.

proxyCountry'AD' | 'AE' | 'AF' | 'AL' | 'AM' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AZ' | 'BA' | 'BD' | 'BE' | 'BG' | 'BH' | 'BJ' | 'BO' | 'BR' | 'BS' | 'BT' | 'BY' | 'BZ' | 'CA' | 'CF' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'EC' | 'EE' | 'EG' | 'ES' | 'ET' | 'EU' | 'FI' | 'FJ' | 'FR' | 'GB' | 'GE' | 'GH' | 'GM' | 'GR' | 'HK' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JM' | 'JO' | 'JP' | 'KE' | 'KH' | 'KR' | 'KW' | 'KZ' | 'LB' | 'LI' | 'LR' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MR' | 'MT' | 'MU' | 'MV' | 'MX' | 'MY' | 'MZ' | 'NG' | 'NL' | 'NO' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PH' | 'PK' | 'PL' | 'PR' | 'PT' | 'PY' | 'QA' | 'RANDOM_COUNTRY' | 'RO' | 'RS' | 'RU' | 'SA' | 'SC' | 'SD' | 'SE' | 'SG' | 'SI' | 'SK' | 'SN' | 'SS' | 'TD' | 'TG' | 'TH' | 'TM' | 'TN' | 'TR' | 'TT' | 'TW' | 'UA' | 'UG' | 'US' | 'UY' | 'UZ' | 'VE' | 'VG' | 'VN' | 'YE' | 'ZA' | 'ZM' | 'ZW' | 'ad' | 'ae' | 'af' | 'al' | 'am' | 'ao' | 'ar' | 'at' | 'au' | 'aw' | 'az' | 'ba' | 'bd' | 'be' | 'bg' | 'bh' | 'bj' | 'bo' | 'br' | 'bs' | 'bt' | 'by' | 'bz' | 'ca' | 'cf' | 'ch' | 'ci' | 'cl' | 'cm' | 'cn' | 'co' | 'cr' | 'cu' | 'cy' | 'cz' | 'de' | 'dj' | 'dk' | 'dm' | 'ec' | 'ee' | 'eg' | 'es' | 'et' | 'eu' | 'fi' | 'fj' | 'fr' | 'gb' | 'ge' | 'gh' | 'gm' | 'gr' | 'hk' | 'hn' | 'hr' | 'ht' | 'hu' | 'id' | 'ie' | 'il' | 'in' | 'iq' | 'ir' | 'is' | 'it' | 'jm' | 'jo' | 'jp' | 'ke' | 'kh' | 'kr' | 'kw' | 'kz' | 'lb' | 'li' | 'lr' | 'lt' | 'lu' | 'lv' | 'ma' | 'mc' | 'md' | 'me' | 'mg' | 'mk' | 'ml' | 'mm' | 'mn' | 'mr' | 'mt' | 'mu' | 'mv' | 'mx' | 'my' | 'mz' | 'ng' | 'nl' | 'no' | 'nz' | 'om' | 'pa' | 'pe' | 'ph' | 'pk' | 'pl' | 'pr' | 'pt' | 'py' | 'qa' | 'ro' | 'rs' | 'ru' | 'sa' | 'sc' | 'sd' | 'se' | 'sg' | 'si' | 'sk' | 'sn' | 'ss' | 'td' | 'tg' | 'th' | 'tm' | 'tn' | 'tr' | 'tt' | 'tw' | 'ua' | 'ug' | 'us' | 'uy' | 'uz' | 've' | 'vg' | 'vn' | 'ye' | 'za' | 'zm' | 'zw'
proxyState'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'al' | 'ak' | 'az' | 'ar' | 'ca' | 'co' | 'ct' | 'de' | 'fl' | 'ga' | 'hi' | 'id' | 'il' | 'in' | 'ia' | 'ks' | 'ky' | 'la' | 'me' | 'md' | 'ma' | 'mi' | 'mn' | 'ms' | 'mo' | 'mt' | 'ne' | 'nv' | 'nh' | 'nj' | 'nm' | 'ny' | 'nc' | 'nd' | 'oh' | 'ok' | 'or' | 'pa' | 'ri' | 'sc' | 'sd' | 'tn' | 'tx' | 'ut' | 'vt' | 'va' | 'wa' | 'wv' | 'wi' | 'wy' nullable

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

proxyCitystring nullable

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

region'us' | 'us-central' | 'us-west' | 'us-east' | 'asia-south' | 'europe-west'

Region to run the session in. The asia-south region is only available on Enterprise and Select plans. Get in touch at https://calendly.com/shri-hyperbrowser/demo.

operatingSystemsOperatingSystem[]
deviceDevice[]
platformPlatform[]
localesISO6391[]
solveCaptchasboolean
solverType'visual'

Optional CAPTCHA solver mode. Set to visual to use the visual reCAPTCHA solver.

adblockboolean
trackersboolean
annoyancesboolean
enableWebRecordingboolean
enableVideoWebRecordingboolean

enableWebRecording must also be true for this to work

acceptCookiesboolean
staticIpIdstring uuid
saveDownloadsboolean
extensionIdsstring[]
urlBlockliststring[]
browserArgsstring[]
timeoutMinutesnumber
enableWindowManagerboolean
enableWindowManagerTaskbarboolean
viewOnlyLiveViewboolean
disablePasswordManagerboolean
enableAlwaysOpenPdfExternallyboolean
disablePostQuantumKeyAgreementboolean
enableWebMcpboolean

Enable discovery and invocation of WebMCP tools exposed by pages in this browser session. Must be set when creating the session; disabled by default.

Example request

{
  "proxyCity": "new york"
}

Response

Session created

idstring uuid
teamIdstring uuid
status'active' | 'closed' | 'error' | 'close-error'
startTimestring timestamp-milliseconds nullable
endTimestring timestamp-milliseconds nullable
createdAtstring iso8601
updatedAtstring iso8601
creditsUsednumber nullable
sessionUrlstring
liveUrlstring
tokenstring
wsEndpointstring
webdriverEndpointstring
computerActionEndpointstring

Changes