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/client.ts Options of client.scrape(): the global scrape request minus url, plus the SDK-only scrape options.

​
Fields

​
number | undefined
Idle timeout in minutes. Session closes after this period of inactivity (resets on each operation).
​
number | undefined
Maximum session lifetime in minutes (absolute maximum, not affected by activity).
​
boolean | (NotteProxy | ExternalProxy | TailnetProxy)[] | undefined
List of custom proxies to use for the session. If True, the default proxies will be used.
​
"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.
​
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 | undefined
Whether to try to automatically solve captchas
​
string | null | undefined
The CDP URL of another remote session provider.
​
boolean | undefined
Whether to use web bot authentication.
​
string[] | undefined
Managed Auth connection IDs to verify and, when necessary, authenticate inside this session before it is returned.
​
string | null | undefined
The vault to use for the session
​
number | undefined
​
string | null | undefined
Additional instructions to use for the scrape. E.g. ‘Extract only the title, date and content of the articles.’
​
boolean | undefined
Whether to only scrape the main content of the page. If True, navbars, footers, etc. are excluded.
​
string | null | undefined
Playwright selector to scope the scrape to. Only content inside this selector will be scraped.
​
boolean | undefined
Whether to only scrape images from the page. If True, the page content is excluded.
​
boolean | undefined
Whether to scrape links from the page. Links are scraped by default.
​
boolean | undefined
Whether to scrape images from the page. Images are scraped by default.
​
string[] | null | undefined
HTML tags to ignore from the page
​
boolean | undefined
Whether to use link/image placeholders to reduce the number of tokens in the prompt and hallucinations. However this is an experimental feature and might not work as expected.
​
string[] | null | undefined
Overwrite the chrome instance arguments
​
"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.
​
"raw" | "full" | "last_action" | undefined
The type of screenshot to use for the session.
​
SessionProfile | null | undefined
Browser profile configuration for state persistence
​
{ [key: string]: string; } | null | undefined
Extra HTTP headers to be sent with every request.
​
boolean | undefined
Enable Notte’s highest-fidelity browser environment for sites with sophisticated bot detection. Available to approved workspaces.
​
Record<string, unknown> | ZodLikeSchema<T> | null | undefined
A Zod schema or a JSON Schema object describing the data to extract.
​
Record<string, unknown> | undefined
JSON Schema to send instead of converting response_format. Only used with a Zod schema.
​
boolean | undefined
When true (default) a failed structured extraction throws ScrapeFailedError and the extracted data is returned directly. When false the StructuredData wrapper is returned so callers can inspect .success.
​
boolean | undefined
Whether to wait for Managed Auth before the scrape request completes. Defaults to true. Authentication failure or timeout can fail the scrape request.