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

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

await client.sessions.create({
  useStealth: true
});
{
  "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,
      "persistNetworkCache": true
    },
    "staticIpId": "<string>",
    "saveDownloads": true,
    "enableWindowManager": true,
    "enableWindowManagerTaskbar": true,
    "viewOnlyLiveView": true,
    "disablePasswordManager": true,
    "enableAlwaysOpenPdfExternally": true,
    "disablePostQuantumKeyAgreement": true
  },
  "creditsUsed": 123,
  "sessionUrl": "<string>",
  "liveUrl": "<string>",
  "token": "<string>",
  "wsEndpoint": "<string>",
  "webdriverEndpoint": "<string>",
  "computerActionEndpoint": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
useUltraStealth
boolean
default:false
​
useStealth
boolean
default:false
​
useProxy
boolean
default:false
​
proxyServer
string
​
proxyServerPassword
string
​
proxyServerUsername
string
​
proxyCountry
enum<string>
Available options:
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
enum<string> | null

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

Available options:
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
​
proxyCity
string | null

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"

​
region
enum<string>
Available options:
us-central,
us-west,
us-east,
asia-south,
europe-west
​
operatingSystems
enum<string>[]
Available options:
windows,
android,
macos,
linux,
ios
​
device
enum<string>[]
Available options:
desktop,
mobile
​
platform
enum<string>[]
Available options:
chrome,
firefox,
safari,
edge
​
locales
enum<string>[]
Available options:
aa,
ab,
ae,
af,
ak,
am,
an,
ar,
as,
av,
ay,
az,
ba,
be,
bg,
bh,
bi,
bm,
bn,
bo,
br,
bs,
ca,
ce,
ch,
co,
cr,
cs,
cu,
cv,
cy,
da,
de,
dv,
dz,
ee,
el,
en,
eo,
es,
et,
eu,
fa,
ff,
fi,
fj,
fo,
fr,
fy,
ga,
gd,
gl,
gn,
gu,
gv,
ha,
he,
hi,
ho,
hr,
ht,
hu,
hy,
hz,
ia,
id,
ie,
ig,
ii,
ik,
io,
is,
it,
iu,
ja,
jv,
ka,
kg,
ki,
kj,
kk,
kl,
km,
kn,
ko,
kr,
ks,
ku,
kv,
kw,
ky,
la,
lb,
lg,
li,
ln,
lo,
lt,
lu,
lv,
mg,
mh,
mi,
mk,
ml,
mn,
mo,
mr,
ms,
mt,
my,
na,
nb,
nd,
ne,
ng,
nl,
nn,
no,
nr,
nv,
ny,
oc,
oj,
om,
or,
os,
pa,
pi,
pl,
ps,
pt,
qu,
rm,
rn,
ro,
ru,
rw,
sa,
sc,
sd,
se,
sg,
si,
sk,
sl,
sm,
sn,
so,
sq,
sr,
ss,
st,
su,
sv,
sw,
ta,
te,
tg,
th,
ti,
tk,
tl,
tn,
to,
tr,
ts,
tt,
tw,
ty,
ug,
uk,
ur,
uz,
ve,
vi,
vo,
wa,
wo,
xh,
yi,
yo,
za,
zh,
zu
​
screen
object
​
solveCaptchas
boolean
default:false
​
adblock
boolean
default:false
​
trackers
boolean
default:false
​
annoyances
boolean
default:false
​
enableWebRecording
boolean
​
enableVideoWebRecording
boolean
default:false

enableWebRecording must also be true for this to work

​
profile
object
​
acceptCookies
boolean
​
staticIpId
string<uuid>
​
saveDownloads
boolean
default:false
​
extensionIds
string<uuid>[]
​
urlBlocklist
string[]
​
browserArgs
string[]
​
imageCaptchaParams
object[] | null
​
timeoutMinutes
number
Required range: 1 <= x <= 720
​
enableWindowManager
boolean
default:false
​
enableWindowManagerTaskbar
boolean
default:false
​
viewOnlyLiveView
boolean
default:false
​
disablePasswordManager
boolean
default:false
​
enableAlwaysOpenPdfExternally
boolean
default:false
​
disablePostQuantumKeyAgreement
boolean
default:false

Response

200 - application/json

Session created

​
id
string<uuid>
​
teamId
string<uuid>
​
status
enum<string>
Available options:
active,
closed,
error
​
startTime
string<timestamp-milliseconds> | null
​
endTime
string<timestamp-milliseconds> | null
​
createdAt
string<iso8601>
​
updatedAt
string<iso8601>
​
launchState
object
​
creditsUsed
number | null
​
sessionUrl
string
​
liveUrl
string
​
token
string
​
wsEndpoint
string
​
webdriverEndpoint
string
​
computerActionEndpoint
string