scrape

AI agent instructions

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/session.ts Scrape the current page. With response_format or instructions, the extracted data is returned directly and a failed extraction throws ScrapeFailedError. Pass raiseOnFailure: false to receive the StructuredData wrapper instead.

Session.scrape(options: SessionScrapeOptions<unknown> & { only_images: true; }): Promise<ImageData[]>;
Session.scrape(options?: SessionScrapeOptions<unknown> & { response_format?: undefined; instructions?: undefined | null; only_images?: false; }): Promise<string>;
Session.scrape<T>(options: SessionScrapeOptions<T> & { response_format: ZodLikeSchema<T>; raiseOnFailure?: true; }): Promise<T>;
Session.scrape<T>(options: SessionScrapeOptions<T> & { response_format: ZodLikeSchema<T>; raiseOnFailure: false; }): Promise<StructuredData<T>>;
Session.scrape(options: SessionScrapeOptions<unknown>): Promise<ScrapeResult<unknown>>;

Parameters (overload 1)

SessionScrapeOptions<unknown> & { only_images: true }

required

Returns (overload 1)

Promise<ImageData[]>

Parameters (overload 2)

SessionScrapeOptions<unknown> & { response_format?: undefined; instructions?: undefined | null; only_images?: false }

Returns (overload 2)

Promise<string>

Parameters (overload 3)

SessionScrapeOptions<T> & { response_format: ZodLikeSchema<T>; raiseOnFailure?: true }

required

Returns (overload 3)

Promise<T>

Parameters (overload 4)

SessionScrapeOptions<T> & { response_format: ZodLikeSchema<T>; raiseOnFailure: false }

required

Returns (overload 4)

Promise<StructuredData<T>>

Parameters (overload 5)

SessionScrapeOptions<unknown>

required

Returns (overload 5)

Promise<ScrapeResult<unknown>>

Example

const markdown = await session.scrape({ only_main_content: true });
const images = await session.scrape({ only_images: true });
const product = await session.scrape({ response_format: Product, instructions: 'Extract the product' });
const result = await session.scrape({ response_format: Product, raiseOnFailure: false });
if (result.success) console.log(result.data);

Getting Started

APIs

Python SDK

Node SDK

Parameters (overload 1)

Returns (overload 1)

Parameters (overload 2)

Returns (overload 2)

Parameters (overload 3)

Returns (overload 3)

Parameters (overload 4)

Returns (overload 4)

Parameters (overload 5)

Returns (overload 5)

Example

​Parameters (overload 1)

​Returns (overload 1)

​Parameters (overload 2)

​Returns (overload 2)

​Parameters (overload 3)

​Returns (overload 3)

​Parameters (overload 4)

​Returns (overload 4)

​Parameters (overload 5)

​Returns (overload 5)

​Example

​Related types

Parameters (overload 1)

Returns (overload 1)

Parameters (overload 2)

Returns (overload 2)

Parameters (overload 3)

Returns (overload 3)

Parameters (overload 4)

Returns (overload 4)

Parameters (overload 5)

Returns (overload 5)

Example

Related types