v2

latestOpenAPI 3.1.02026-07-3176157210.9 KB

scrape

Scrape Webpage

post/scrape

Headers

x-notte-request-originstring nullable

x-notte-sdk-versionstring nullable

Request body

headlessboolean

Whether to run the session in headless mode.

solve_captchasboolean

Whether to try to automatically solve captchas

max_duration_minutesinteger

Maximum session lifetime in minutes (absolute maximum, not affected by activity).

idle_timeout_minutesinteger

Idle timeout in minutes. Session closes after this period of inactivity (resets on each operation).

browser_type'chromium' | 'chrome' | 'chrome-nightly' | 'chrome-turbo'

The browser type to use. Supported values are chromium and chrome. chrome-nightly and chrome-turbo are legacy aliases for chrome.

user_agentstring nullable

The user agent to use for the session

chrome_argsstring[] nullable

Overwrite the chrome instance arguments

viewport_widthinteger nullable

The width of the viewport

viewport_heightinteger nullable

The height of the viewport

aspect_ratio'5:4' | '16:9' nullable

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.

cdp_urlstring nullable

The CDP URL of another remote session provider.

use_file_storageboolean

Whether FileStorage should be attached to the session.

screenshot_type'raw' | 'full' | 'last_action'

The type of screenshot to use for the session.

web_bot_authboolean

Whether to use web bot authentication.

extra_http_headersobject nullable

Extra HTTP headers to be sent with every request.

vault_idstring nullable

The vault to use for the session

selectorstring nullable

Playwright selector to scope the scrape to. Only content inside this selector will be scraped.

scrape_linksboolean

Whether to scrape links from the page. Links are scraped by default.

scrape_imagesboolean

Whether to scrape images from the page. Images are scraped by default.

ignored_tagsstring[] nullable

HTML tags to ignore from the page

only_main_contentboolean

Whether to only scrape the main content of the page. If True, navbars, footers, etc. are excluded.

only_imagesboolean

Whether to only scrape images from the page. If True, the page content is excluded.

{"stackTrail":"components:schemas:GlobalScrapeRequest:properties:response_format:anyOf","oasType":"schema","type":"unknown","title":"Response Format","description":"The response format to use for the scrape. You can use a Pydantic model or a JSON Schema dict (cf. https://docs.pydantic.dev/latest/concepts/json_schema/#generating-json-schema.)","nullable":true}

instructionsstring nullable

Additional instructions to use for the scrape. E.g. 'Extract only the title, date and content of the articles.'

use_link_placeholdersboolean

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.

urlstring required

Response

Successful Response

markdownstring required

Markdown representation of the extracted data