> ## 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.

# Get started

> Creating and using a browsing session

<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>

Sessions provide a context manager for browser automation:

{/* @sniptest testers/sessions/index.py */}

```python session.py theme={null}
from notte_sdk import NotteClient

client = NotteClient()

# The session is automatically stopped when the context manager is exited
with client.Session(idle_timeout_minutes=2) as session:
    status = session.status()
    print(status)
```

## Usage

See more operations on sessions:

<CardGroup cols={3}>
  <Card title="Scrape" icon="download" href="../remotesession/scrape">
    Get the relevant information from a page
  </Card>

  <Card title="Observe" icon="telescope" href="../remotesession/observe">
    Retrieve information and available actions on a page
  </Card>

  <Card title="Execute" icon="shoe-prints" href="../remotesession/execute">
    Take action on a page
  </Card>
</CardGroup>

## Parameters

You can use the default parameters to create your session, or customize them:

<ParamField path="session_id" type="UnionType[str, None]" default="None" />

<ParamField path="storage" type="UnionType[RemoteFileStorage, None]" default="None">
  File Storage to attach to the session
</ParamField>

<ParamField path="perception_type" type="Literal['fast', 'deep']" default="fast" />

<ParamField path="cookie_file" type="UnionType[str, Path, None]" default="None" />

<ParamField path="raise_on_failure" type="bool" default="True" />

<ParamField path="open_viewer" type="bool" default="False">
  Whether to open the live viewer when the session starts (default: False).         Browsers are always headless; this controls only the viewer popup.
</ParamField>

<ParamField path="headless" type="bool">
  Whether to run the session in headless mode.
</ParamField>

<ParamField path="solve_captchas" type="bool">
  Whether to try to automatically solve captchas
</ParamField>

<ParamField path="max_duration_minutes" type="int">
  Maximum session lifetime in minutes (absolute maximum).
</ParamField>

<ParamField path="idle_timeout_minutes" type="int">
  Idle timeout in minutes. Session closes after this period of inactivity.
</ParamField>

<ParamField path="proxies" type="typing.Union[list[typing.Annotated[notte_sdk.types.NotteProxy | notte_sdk.types.ExternalProxy | notte_sdk.types.TailnetProxy, FieldInfo(annotation=NoneType, required=True, discriminator='type')]], list[typing.Annotated[notte_sdk.types.NotteProxyDict | notte_sdk.types.ExternalProxyDict | notte_sdk.types.TailnetProxyDict, FieldInfo(annotation=NoneType, required=True, discriminator='type')]], bool, notte_sdk.types.ProxyGeolocationCountry, typing.Literal['ad', 'ae', 'af', 'ag', 'ai', 'al', 'am', 'ao', 'ar', 'at', 'au', 'aw', 'az', 'ba', 'bb', 'bd', 'be', 'bf', 'bg', 'bh', 'bi', 'bj', 'bm', 'bn', 'bo', 'bq', 'br', 'bs', 'bt', 'bw', 'by', 'bz', 'ca', 'cd', 'cg', 'ch', 'ci', 'cl', 'cm', 'cn', 'co', 'cr', 'cu', 'cv', 'cw', 'cy', 'cz', 'de', 'dj', 'dk', 'dm', 'do', 'dz', 'ec', 'ee', 'eg', 'es', 'et', 'fi', 'fj', 'fr', 'ga', 'gb', 'gd', 'ge', 'gf', 'gg', 'gh', 'gi', 'gm', 'gn', 'gp', 'gq', 'gr', 'gt', 'gu', 'gw', 'gy', 'hk', 'hn', 'hr', 'ht', 'hu', 'id', 'ie', 'il', 'im', 'in', 'iq', 'ir', 'is', 'it', 'je', 'jm', 'jo', 'jp', 'ke', 'kg', 'kh', 'kn', 'kr', 'kw', 'ky', 'kz', 'la', 'lb', 'lc', 'lk', 'lr', 'ls', 'lt', 'lu', 'lv', 'ly', 'ma', 'md', 'me', 'mf', 'mg', 'mk', 'ml', 'mm', 'mn', 'mo', 'mq', 'mr', 'mt', 'mu', 'mv', 'mw', 'mx', 'my', 'mz', 'na', 'nc', 'ne', 'ng', 'ni', 'nl', 'no', 'np', 'nz', 'om', 'pa', 'pe', 'pf', 'pg', 'ph', 'pk', 'pl', 'pr', 'ps', 'pt', 'py', 'qa', 're', 'ro', 'rs', 'ru', 'rw', 'sa', 'sc', 'sd', 'se', 'sg', 'si', 'sk', 'sl', 'sm', 'sn', 'so', 'sr', 'ss', 'st', 'sv', 'sx', 'sy', 'sz', 'tc', 'tg', 'th', 'tj', 'tm', 'tn', 'tr', 'tt', 'tw', 'tz', 'ua', 'ug', 'us', 'uy', 'uz', 'vc', 've', 'vg', 'vi', 'vn', 'ye', 'za', 'zm', 'zw']]">
  List of custom proxies to use for the session. If True, the default proxies will be used.
</ParamField>

<ParamField path="browser_type" type="typing.Literal['chromium', 'chrome', 'firefox', 'chrome-nightly', 'chrome-turbo']">
  The browser type to use. Can be chromium or chrome.
</ParamField>

<ParamField path="user_agent" type="str | None">
  The user agent to use for the session
</ParamField>

<ParamField path="chrome_args" type="list">
  Overwrite the chrome instance arguments
</ParamField>

<ParamField path="viewport_width" type="int | None">
  The width of the viewport
</ParamField>

<ParamField path="viewport_height" type="int | None">
  The height of the viewport
</ParamField>

<ParamField path="aspect_ratio" type="typing.Optional[typing.Literal['5:4', '16:9']]">
  Viewport shape preset ("5:4" or "16:9"). Cannot be combined with viewport\_width/viewport\_height.
</ParamField>

<ParamField path="cdp_url" type="str | None">
  The CDP URL of another remote session provider.
</ParamField>

<ParamField path="use_file_storage" type="bool">
  Whether FileStorage should be attached to the session.
</ParamField>

<ParamField path="screenshot_type" type="typing.Literal['raw', 'full', 'last_action']">
  The type of screenshot to use for the session.
</ParamField>

<ParamField path="profile" type="notte_sdk.types.SessionProfileDict | notte_sdk.types.SessionProfile | None">
  Browser profile configuration for state persistence.
</ParamField>

<ParamField path="web_bot_auth" type="bool" />

<ParamField path="extra_http_headers" type="dict[str, str] | None" />

<ParamField path="vault_id" type="str | None" />