> ## Documentation Index
> Fetch the complete documentation index at: https://hyperbrowser.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Session Parameters

> Learn about the parameters that can be used to configure Hyperbrowser sessions

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](/api-reference/create-new-session) for full REST details.

<Tip>
  Proxy usage and CAPTCHA solving require a paid plan.
</Tip>

<Note>
  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 theme={null}
  # Python SDK
  CreateSessionParams(
      use_proxy=True,
      proxy_country="US"
  )
  ```
</Note>

## Session Parameters

<ParamField path="useUltraStealth" type="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](mailto:info@hyperbrowser.ai) to get access.
</ParamField>

<ParamField path="useStealth" type="boolean" default={false}>
  When `true`, launches the session with standard stealth techniques to reduce bot detection.
</ParamField>

<ParamField path="useProxy" type="boolean" default={false}>
  When `true`, the session will be launched with a proxy.
</ParamField>

<ParamField path="proxyServer" type="string">
  Custom proxy server host (used only when `useProxy` is `true`). **Enterprise plan only.** Contact [info@hyperbrowser.ai](mailto:info@hyperbrowser.ai) to get access.
</ParamField>

<ParamField path="proxyServerUsername" type="string">
  Username for authenticating with the custom proxy server. **Enterprise plan only.**
</ParamField>

<ParamField path="proxyServerPassword" type="string">
  Password for authenticating with the custom proxy server. **Enterprise plan only.**
</ParamField>

<ParamField path="proxyCountry" type="string" default="US">
  Country for proxy location (ISO 3166-1 alpha-2 code, e.g., `"US"`, `"GB"`, `"CA"`).
  Check [here](/api-reference/create-new-session#body-proxy-country) for the full list of supported countries.
</ParamField>

<ParamField path="proxyState" type="string">
  Optional state code for proxies to US states. Is mutually exclusive with proxyCity. Takes in two letter state code.
  Check [here](/api-reference/create-new-session#body-proxy-state) for the full list of supported states.
</ParamField>

<ParamField path="proxyCity" type="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.
</ParamField>

<ParamField path="region" type="string">
  Region to run the browser session in.
  Check [here](/api-reference/create-new-session#body-region) for the full list of supported regions.
</ParamField>

<ParamField path="screen" type="object">
  Screen resolution to emulate. Properties:

  * `width` (number, default `1280`)
  * `height` (number, default `720`)
</ParamField>

<ParamField path="solveCaptchas" type="boolean" default={false}>
  When `true`, the session will attempt to automatically solve CAPTCHAs.
</ParamField>

<ParamField path="solverType" type="&#x22;visual&#x22;">
  Optional CAPTCHA solver mode. Set to `"visual"` to use the visual reCAPTCHA solver when automatic CAPTCHA solving is enabled. In the Python SDK, use `solver_type`.
</ParamField>

<ParamField path="adblock" type="boolean" default={false}>
  Block advertisements during the session.
</ParamField>

<ParamField path="trackers" type="boolean" default={false}>
  Block trackers and other privacy-invasive technologies during the session.
</ParamField>

<ParamField path="annoyances" type="boolean" default={false}>
  Block common annoyances like pop-ups and overlays.
</ParamField>

<ParamField path="acceptCookies" type="boolean" default={false}>
  Automatically accept cookies on visited sites.
</ParamField>

<ParamField path="enableWebRecording" type="boolean" default={true}>
  Enable web recording using rrweb.
</ParamField>

<ParamField path="enableVideoWebRecording" type="boolean" default={false}>
  Enable mp4 video recording which captures the entire screen.
</ParamField>

<ParamField path="profile" type="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
</ParamField>

<ParamField path="staticIpId" type="string">
  Static IP ID to use for the session. Check the [Static IPs](/sessions/static-ips) page for more information.
</ParamField>

<ParamField path="saveDownloads" type="boolean" default={false}>
  Save downloads to the session. Check the [Downloads](/sessions/downloads) page for more information.
</ParamField>

<ParamField path="extensionIds" type="array">
  Array of extension IDs to load. Check the [Extensions](/sessions/extensions) page for more information.
</ParamField>

<ParamField path="urlBlocklist" type="array">
  URLs to block during the session.
</ParamField>

<ParamField path="imageCaptchaParams" type="array[object]" nullable>
  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.
</ParamField>

<ParamField path="timeoutMinutes" type="number">
  Session timeout in minutes. Overrides your default team timeout from [Settings](https://app.hyperbrowser.ai/settings).
</ParamField>

<ParamField path="enableWindowManager" type="boolean" default={false}>
  Enable window manager to manage browser windows and tabs.
</ParamField>

<ParamField path="enableWindowManagerTaskbar" type="boolean" default={false}>
  Enable window manager taskbar to manage browser windows and tabs.
</ParamField>

<ParamField path="viewOnlyLiveView" type="boolean" default={false}>
  Enable read-only Live View which disables user interactions.
</ParamField>

<ParamField path="disablePasswordManager" type="boolean" default={false}>
  Disable the browser password manager popup on logins.
</ParamField>

<ParamField path="enableAlwaysOpenPdfExternally" type="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.
</ParamField>