NOnotte
sessions
page

Page Scrape

Changed on
post/sessions/{session_id}/page/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

Path parameters

session_idstring required

Query parameters

update_metadataboolean

Headers

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

Request body

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.

Response

Successful Response

markdownstring required

Markdown representation of the extracted data

Changes

  • 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

  • 5265494c1d7cRevision changes
    • info

      added the new optional request property