Create new session
Authorizations
Body
Custom proxy server host.
Password for authenticating with the custom proxy server.
Username for authenticating with the custom proxy server.
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 Optional state code for proxies to US states. Is mutually exclusive with proxyCity. Takes in two letter state code.
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 Desired Country. Is mutually exclusive with proxyState. Some cities might not be supported, so before using a new city, we recommend trying it out
"new york"
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.
us, us-central, us-west, us-east, asia-south, europe-west windows, android, macos, linux, ios desktop, mobile chrome, firefox, safari, edge 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 Optional CAPTCHA solver mode. Set to visual to use the visual reCAPTCHA solver.
visual enableWebRecording must also be true for this to work
1 <= x <= 720Enable discovery and invocation of WebMCP tools exposed by pages in this browser session. Must be set when creating the session; disabled by default.
Secrets the session may fill with POST /api/session/{id}/credentials/fill: a secret's name, {"secret": name}, {"vault": name} for the secrets a vault's entries point at, or {"onePassword": name} for an op_token secret that 1Password fills read with. You can only attach them when you create the session; an empty list is the same as none. Only secret and totp secrets can be attached as a name, secret or vault entry, and only an op_token as onePassword. Requires secrets to be enabled for your team; please contact support to enable them (otherwise 403 SECRETS_FEATURE_DISABLED), and, for restricted API keys, the secrets.use scope. The session runs on a Firecracker browser and Chrome's password manager is turned off. An unknown name returns 404 SECRET_NOT_FOUND or VAULT_NOT_FOUND, an op_token secret named as a credential, or a onePassword that isn't an op_token, 409 SECRET_TYPE_MISMATCH and a vault without entries 400 SECRET_SOURCES_INVALID. If the session can't run on Firecracker, you get 400 CREDENTIALS_UNSUPPORTED_RUNTIME, or 429 when no Firecracker host is free (retry shortly). Restoring a browser snapshot taken with the password manager on returns 400 CREDENTIALS_SNAPSHOT_PASSWORD_MANAGER_ENABLED.
20A secret's name.
^[a-zA-Z0-9][a-zA-Z0-9_-]{0,127}$Sign the session's requests with Web Bot Auth so websites can verify that they come from Hyperbrowser. Pass {"onlyDomains": [...]} to sign only for those hosts. Available on request: contact info@hyperbrowser.ai to get access. Supported when creating a session and for agent tasks; scrape, crawl, and extract reject it. Cannot be combined with useUltraStealth or startFromSnapshot.
Choose, per host, whether traffic goes through the session's proxy or straight out. The first route that matches a host decides; hosts that no route matches use the proxy. At most 128 patterns across all routes. Requires useProxy. Available on request: contact info@hyperbrowser.ai to get access. See proxy routes. Only supported when creating a session; cannot be combined with allowInternetAccess: false, allowOut, or denyOut.
32Response
Session created
active, closed, error, close-error The secrets attached to the session, including those from vaults. Present only when you requested credentials.