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

# ScrapeRequest

<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/lib/client/types.gen.ts](https://github.com/nottelabs/notte/blob/main/node-sdk/src/lib/client/types.gen.ts#L4350)

```typescript theme={null}
export type ScrapeRequest = {
    /**
     * Selector
     *
     * Playwright selector to scope the scrape to. Only content inside this selector will be scraped.
     */
    selector?: string | null;
    /**
     * Scrape Links
     *
     * Whether to scrape links from the page. Links are scraped by default.
     */
    scrape_links?: boolean;
    /**
     * Scrape Images
     *
     * Whether to scrape images from the page. Images are scraped by default.
     */
    scrape_images?: boolean;
    /**
     * Ignored Tags
     *
     * HTML tags to ignore from the page
     */
    ignored_tags?: Array<string> | null;
    /**
     * Only Main Content
     *
     * Whether to only scrape the main content of the page. If True, navbars, footers, etc. are excluded.
     */
    only_main_content?: boolean;
    /**
     * Only Images
     *
     * Whether to only scrape images from the page. If True, the page content is excluded.
     */
    only_images?: boolean;
    /**
     * Response Format
     *
     * The response format to use for the scrape. Use a JSON Schema object; high-level Node agent and scrape methods also accept a Zod schema
     */
    response_format?: unknown | null;
    /**
     * Instructions
     *
     * Additional instructions to use for the scrape. E.g. 'Extract only the title, date and content of the articles.'
     */
    instructions?: string | null;
    /**
     * Use Link Placeholders
     *
     * 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.
     */
    use_link_placeholders?: boolean;
};
```

## Fields

<ParamField body="selector" type={"string | null | undefined"}>
  Playwright selector to scope the scrape to. Only content inside this selector will be scraped.
</ParamField>

<ParamField body="scrape_links" type={"boolean | undefined"}>
  Whether to scrape links from the page. Links are scraped by default.
</ParamField>

<ParamField body="scrape_images" type={"boolean | undefined"}>
  Whether to scrape images from the page. Images are scraped by default.
</ParamField>

<ParamField body="ignored_tags" type={"string[] | null | undefined"}>
  HTML tags to ignore from the page
</ParamField>

<ParamField body="only_main_content" type={"boolean | undefined"}>
  Whether to only scrape the main content of the page. If True, navbars, footers, etc. are excluded.
</ParamField>

<ParamField body="only_images" type={"boolean | undefined"}>
  Whether to only scrape images from the page. If True, the page content is excluded.
</ParamField>

<ParamField body="response_format" type={"unknown"}>
  The response format to use for the scrape. Use a JSON Schema object; high-level Node agent and scrape methods also accept a Zod schema
</ParamField>

<ParamField body="instructions" type={"string | null | undefined"}>
  Additional instructions to use for the scrape. E.g. 'Extract only the title, date and content of the articles.'
</ParamField>

<ParamField body="use_link_placeholders" type={"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.
</ParamField>