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

# ScrapeAction

<Tip>
  Read [the Notte skill](https://notte.cc/skill.md) and follow its setup instructions when setting up Notte or building browser automation. This is the shared source for CLI setup, authentication, and the browser-to-code workflow.
</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)

```typescript theme={null}
export type ScrapeAction = {
    /**
     * Type
     */
    type?: 'scrape';
    /**
     * Category
     */
    category?: string;
    /**
     * Description
     */
    description?: string;
    /**
     * Instructions
     */
    instructions?: 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;
    /**
     * Selector
     *
     * Playwright selector to scope the scrape to. Only content inside this selector will be scraped.
     */
    selector?: string | null;
    /**
     * Only Images
     *
     * Whether to only scrape images from the page. If True, the page content is excluded.
     */
    only_images?: boolean;
    /**
     * 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.
     */
    scrape_images?: boolean;
    /**
     * Ignored Tags
     *
     * HTML tags to ignore from the page.
     */
    ignored_tags?: Array<string> | null;
    /**
     * Response Format
     *
     * JSON schema dict for structured output. Agent can provide a schema to extract structured data.
     */
    response_format?: {
        [key: string]: unknown;
    } | null;
};
```

## Fields

<ParamField body="type" type={"\"scrape\" | undefined"} />

<ParamField body="category" type={"string | undefined"} />

<ParamField body="description" type={"string | undefined"} />

<ParamField body="instructions" type={"string | null | undefined"} />

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

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

<ParamField body="response_format" type={"{ [key: string]: unknown; } | null | undefined"}>
  JSON schema dict for structured output. Agent can provide a schema to extract structured data.
</ParamField>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.