Skip to main content
STOP. Do not read past this section until you have read and followed /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.
Source: node-sdk/src/lib/client/types.gen.ts

Fields

string
required
The ID of the session (created or existing). Use this ID to interact with the session for the next operation.
number
required
Session idle timeout in minutes. Will timeout if now() > last access time + idle_timeout_minutes
number | undefined
Session max duration in minutes. Will timeout if now() > creation time + max_duration_minutes
string
required
Session creation time
string | null | undefined
Session closing time
string
required
Last access time
string | undefined
Session duration
"active" | "closed" | "error" | "timed_out"
required
Session status
"unknown" | "error" | "manual" | "idle_timeout" | "max_duration" | null | undefined
Reason the session closed, if it is no longer active
{ [key: string]: unknown; }[] | undefined
Steps of the session
string | null | undefined
Error message if the operation failed to complete
boolean | undefined
Whether proxies were used for the session. True if any proxy was applied during session creation.
"chromium" | "chrome" | "chrome-nightly" | "chrome-turbo" | "firefox" | undefined
number | undefined
Total byte usage for network requests.
number | undefined
Total byte usage for network responses.
string | null | undefined
The user agent to use for the session
number | null | undefined
The width of the viewport
number | null | undefined
The height of the viewport
boolean | null | undefined
Whether to solve captchas.
string | null | undefined
The URL to connect to the CDP server.
string | null | undefined
The remote session viewer URL.
boolean | undefined
Whether to use web bot authentication.
string[] | undefined
Managed Auth connection IDs attached to this session.
boolean | undefined
Whether this session is an internal system run. Internal system runs are omitted from session.list() unless include_system=True is requested.
number
required
deprecated: