NOnotte
scrape

Scrape Webpage

Changed on
post/scrape

Request

  • Base URL
    https://api.notte.cc (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: token

Headers

x-notte-request-originstring nullable
x-notte-sdk-versionstring nullable

Request body

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

Viewport width in pixels (minimum 500). Set together with viewport_height.

viewport_heightinteger nullable

Viewport height in pixels (minimum 500). Set together with viewport_width.

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.

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

auth_idsstring[]

Managed Auth connection IDs to verify and, when necessary, authenticate inside this session before it is returned.

wait_for_authenticationboolean

Whether to wait for Managed Auth before returning the session. Defaults to true. When true, authentication failure or timeout fails session creation; when false, authentication continues in the background after the browser is ready.

record_sessionboolean

Save session replay. False permanently disables saved replay; Live View remains available.

log_sessionboolean

Save browser session logs. False permanently disables saved logs, without disabling metering.

auth_retryinteger
block_adsboolean

Block ads and trackers in managed browsers using Basic filtering. Set false to disable. Does not configure externally supplied CDP browsers.

advanced_stealthboolean

Enable Notte's highest-fidelity browser environment for sites with sophisticated bot detection. Available to approved workspaces.

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

Ignored since notte 1.10: screenshots are returned without highlighting.

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

Image scraping was removed; true returns 422.

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.

response_formatunknown
instructionsstring nullable

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

modelstring nullable

Model used for structured extraction. Canonical OpenRouter ids: google/gemini-3.5-flash, google/gemini-3.5-flash-lite, google/gemini-3.1-flash-lite, google/gemini-3.1-flash-lite-preview, google/gemini-2.5-flash, openai/gpt-4.1-mini, openai/gpt-4o, google/gemma-3-27b-it, openai/gpt-oss-120b, perplexity/sonar-pro, deepseek/deepseek-r1, meta-llama/llama-3.3-70b-instruct, anthropic/claude-sonnet-4-5, anthropic/claude-haiku-4-5, moonshotai/kimi-k2.5, x-ai/grok-4.3, minimax/minimax-m2.5. Reviewed legacy LiteLLM ids remain accepted. Defaults to google/gemini-3.5-flash.

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.

only_imagesboolean

Image scraping was removed; true returns 422.

urlstring required

Response

Successful Response

markdownstring required

Markdown representation of the extracted data

Changes

  • 604cdfbc3693Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

  • 4d05dac78797Revision changes
    • breaking

      removed from the request property anyOf list

    • warning

      removed the optional property from the response with the status

    • info

      request property deprecated

    • info

      request property deprecated

    • info

      request property deprecated