Skip to main content
This page documents the parameters that can be used to configure Hyperbrowser sessions. These parameters are shared across New Session, Scrape, Crawl, Extract, and Agent Tasks. You can view the Sessions API Reference at Sessions API Reference for full REST details.
Proxy usage and CAPTCHA solving require a paid plan.
When using the Python SDK, all session parameters are in snake_case (e.g., use_proxy), whereas in JavaScript/TypeScript they use camelCase (e.g., useProxy). Example:
# Python SDK
CreateSessionParams(
    use_proxy=True,
    proxy_country="US"
)

​
Session Parameters

​
useUltraStealth
boolean
default:false
When true, launches the session with advanced stealth techniques to reduce bot detection. This is only available on enterprise plans. Please contact us at info@hyperbrowser.ai to get access.
​
useStealth
boolean
default:false
When true, launches the session with standard stealth techniques to reduce bot detection.
​
useProxy
boolean
default:false
When true, the session will be launched with a proxy.
​
proxyServer
string
Custom proxy server host (used only when useProxy is true).
​
proxyServerUsername
string
Username for authenticating with the custom proxy server.
​
proxyServerPassword
string
Password for authenticating with the custom proxy server.
​
proxyCountry
string
default:"US"
Country for proxy location (ISO 3166-1 alpha-2 code, e.g., "US", "GB", "CA"). Check here for the full list of supported countries.
​
proxyState
string
Optional state code for proxies to US states. Is mutually exclusive with proxyCity. Takes in two letter state code. Check here for the full list of supported states.
​
proxyCity
string
Desired City. Is mutually exclusive with proxyState. Some cities might not be supported, so before using a new city, we recommend trying it out.
​
region
string
Region to run the browser session in. Check here for the full list of supported regions.
​
screen
object
Screen resolution to emulate. Properties:
  • width (number, default 1280)
  • height (number, default 720)
​
solveCaptchas
boolean
default:false
When true, the session will attempt to automatically solve CAPTCHAs.
​
adblock
boolean
default:false
Block advertisements during the session.
​
trackers
boolean
default:false
Block trackers and other privacy-invasive technologies during the session.
​
annoyances
boolean
default:false
Block common annoyances like pop-ups and overlays.
​
acceptCookies
boolean
default:false
Automatically accept cookies on visited sites.
​
enableWebRecording
boolean
default:true
Enable web recording using rrweb.
​
enableVideoWebRecording
boolean
default:false
Enable mp4 video recording which captures the entire screen.
​
profile
object
Reuse browser state across sessions. Properties:
  • id (string): Profile ID to use for the session
  • persistChanges (boolean, default false): Persist changes back to the profile on session close
​
acceptCookies
boolean
default:false
Automatically accept cookies on visited sites.
​
staticIpId
string
Static IP ID to use for the session. Check the Static IPs page for more information.
​
saveDownloads
boolean
default:false
Save downloads to the session. Check the Downloads page for more information.
​
extensionIds
array
Array of extension IDs to load. Check the Extensions page for more information.
​
urlBlocklist
array
URLs to block during the session.
​
imageCaptchaParams
array[object]
Array of objects for customizing image captcha solving. Each object supports:
  • imageSelector (string): CSS selector for the captcha image element.
  • inputSelector (string): CSS selector for the input field where the captcha answer should be entered.
​
timeoutMinutes
number
Session timeout in minutes. Overrides your default team timeout from Settings.
​
enableWindowManager
boolean
default:false
Enable window manager to manage browser windows and tabs.
​
enableWindowManagerTaskbar
boolean
default:false
Enable window manager taskbar to manage browser windows and tabs.
​
viewOnlyLiveView
boolean
default:false
Enable read-only Live View which disables user interactions.
​
disablePasswordManager
boolean
default:false
Disable the browser password manager popup on logins.
​
enableAlwaysOpenPdfExternally
boolean
default:false
Always open PDFs externally instead of in browser. This will download the PDF instead of opening it in the browser PDF viewer.