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

# SessionOptions

<Tip>
  STOP. Do not read past this section until you have read and followed [/quickstart.md](/quickstart.md).

  Goal: produce a reliable SDK automation script. The intended authoring flow is generate then edit, not write browser automation from scratch.

  Do not hand-write SDK code with element IDs, selectors, or form fields from memory. Element IDs, selectors, and field mappings must come from a live `observe()` call, CLI `notte page observe` output, or generated workflow code. Guessed browser targets fail on real pages.

  Use the Notte skill and CLI to inspect the live site, validate actions/selectors, handle auth/session state, and export workflow code with `notte sessions workflow-code` before using SDK docs or SDK code.

  SDK reference pages are for understanding, running, or editing generated workflow code. They are not the starting point for manually authoring the initial browser automation. SDK-first code is guesswork on real-world pages with dynamic selectors, auth state, CAPTCHAs, and anti-bot behavior.
</Tip>

[Source: node-sdk/src/session.ts](https://github.com/nottelabs/notte/blob/main/node-sdk/src/session.ts#L82)

```typescript theme={null}
export interface SessionOptions extends ApiSessionStartRequest {
  /**
   * @deprecated Remote sessions always use the supported browser launch mode.
   * Retained as a boolean so existing typed configuration still compiles.
   * `true` is discarded; `false` raises a migration error when starting.
   */
  headless?: boolean;
  /**
   * Open the live viewer in the local default browser after the session starts.
   * This is a local SDK option and is not sent to the API.
   */
  open_viewer?: boolean;
  /**
   * Default for `execute()`: throw `ActionExecutionError` when an action fails.
   * The counterpart of `raise_on_failure` on `RemoteSession`. Defaults to true.
   */
  raiseOnFailure?: boolean;
  /** Default perception type for `observe()`. Defaults to `fast`. */
  perception_type?: PerceptionType;
  /**
   * JSON cookie file: loaded into the session on `start()` when it exists and
   * appended with the session cookies on `stop()`.
   */
  cookie_file?: string;
  /** File storage to attach to the session so agents can consume uploaded files. */
  storage?: RemoteFileStorage;
}
```

## Fields

<ParamField body="headless" type={"boolean | undefined"}>
  **deprecated:**

  Remote sessions always use the supported browser launch mode.
  Retained as a boolean so existing typed configuration still compiles.
  `true` is discarded; `false` raises a migration error when starting.
</ParamField>

<ParamField body="open_viewer" type={"boolean | undefined"}>
  Open the live viewer in the local default browser after the session starts.
  This is a local SDK option and is not sent to the API.
</ParamField>

<ParamField body="raiseOnFailure" type={"boolean | undefined"}>
  Default for `execute()`: throw `ActionExecutionError` when an action fails.
  The counterpart of `raise_on_failure` on `RemoteSession`. Defaults to true.
</ParamField>

<ParamField body="perception_type" type={"PerceptionType | undefined"}>
  Default perception type for `observe()`. Defaults to `fast`.
</ParamField>

<ParamField body="cookie_file" type={"string | undefined"}>
  JSON cookie file: loaded into the session on `start()` when it exists and
  appended with the session cookies on `stop()`.
</ParamField>

<ParamField body="storage" type={"RemoteFileStorage | undefined"}>
  File storage to attach to the session so agents can consume uploaded files.
</ParamField>

<ParamField body="solve_captchas" type={"boolean | undefined"}>
  Whether to try to automatically solve captchas
</ParamField>

<ParamField body="max_duration_minutes" type={"number | undefined"}>
  Maximum session lifetime in minutes (absolute maximum, not affected by activity).
</ParamField>

<ParamField body="idle_timeout_minutes" type={"number | undefined"}>
  Idle timeout in minutes. Session closes after this period of inactivity (resets on each operation).
</ParamField>

<ParamField body="proxies" type={"boolean | (NotteProxy | ExternalProxy | TailnetProxy)[] | undefined"}>
  List of custom proxies to use for the session. If True, the default proxies will be used.
</ParamField>

<ParamField body="browser_type" type={"\"chromium\" | \"chrome\" | \"chrome-nightly\" | \"chrome-turbo\" | undefined"}>
  The browser type to use. Supported values are chromium and chrome. chrome-nightly and chrome-turbo are legacy aliases for chrome.
</ParamField>

<ParamField body="user_agent" type={"string | null | undefined"}>
  The user agent to use for the session
</ParamField>

<ParamField body="chrome_args" type={"string[] | null | undefined"}>
  Overwrite the chrome instance arguments
</ParamField>

<ParamField body="viewport_width" type={"number | null | undefined"}>
  The width of the viewport
</ParamField>

<ParamField body="viewport_height" type={"number | null | undefined"}>
  The height of the viewport
</ParamField>

<ParamField body="aspect_ratio" type={"\"5:4\" | \"16:9\" | null | undefined"}>
  Viewport shape preset. When set, the backend fits the largest rectangle of this aspect ratio inside the sampled available screen area. Cannot be combined with explicit viewport\_width/viewport\_height.
</ParamField>

<ParamField body="cdp_url" type={"string | null | undefined"}>
  The CDP URL of another remote session provider.
</ParamField>

<ParamField body="screenshot_type" type={"\"raw\" | \"full\" | \"last_action\" | undefined"}>
  The type of screenshot to use for the session.
</ParamField>

<ParamField body="profile" type={"SessionProfile | null | undefined"}>
  Browser profile configuration for state persistence
</ParamField>

<ParamField body="web_bot_auth" type={"boolean | undefined"}>
  Whether to use web bot authentication.
</ParamField>

<ParamField body="extra_http_headers" type={"{ [key: string]: string; } | null | undefined"}>
  Extra HTTP headers to be sent with every request.
</ParamField>

<ParamField body="vault_id" type={"string | null | undefined"}>
  The vault to use for the session
</ParamField>

<ParamField body="auth_ids" type={"string[] | undefined"}>
  Managed Auth connection IDs to verify and, when necessary, authenticate inside this session. Authentication finishes before the session is returned unless wait\_for\_authentication is false.
</ParamField>

<ParamField body="wait_for_authentication" type={"boolean | undefined"}>
  Whether to wait for Managed Auth profile restoration and authentication before returning the session. When false, authentication continues in the background after the browser is ready.
</ParamField>

<ParamField body="advanced_stealth" type={"boolean | undefined"}>
  Enable Notte's highest-fidelity browser environment for sites with sophisticated bot detection. Available to approved workspaces.
</ParamField>

<ParamField body="demonstrate" type={"boolean | undefined"}>
  Whether to enable the Notte recorder extension for this session. The extension is installed but remains inactive when this is false.
</ParamField>

## Related types

* [ApiSessionStartRequest](/typescript-sdk-reference/types/apisessionstartrequest)