// request reference
Fetch parameters
Send query parameters with GET /api/web/fetch. Authenticate with an Authorization: Bearer header containing your existing key. Keep keys on your server, not in browser code.
The groups below list every request field, including compatibility restrictions. Read the extended reference for detailed types, defaults, parameter combinations and additional examples.
Page
Render a public page in a fresh browser and return its content.
urlRequired public HTTP(S) URL, up to 8,192 characters. Standard ports only, no credentials.
Example / input hint: https://litescrape.com
respond_withScreenshots return a base64 PNG.
markdownhtmltextscreenshotExtraction
target_selectorCSS selector to extract, up to 2,048 characters. Falls back to the full page when nothing matches.
Example / input hint: article
remove_selectorCSS selector removed before extraction, up to 2,048 characters.
Example / input hint: nav, footer
with_linksHow Markdown writes links.
inlinedreferencedcollapsedshortcutdiscardedwith_imagesHow Markdown writes images.
allaltnonewith_iframeInclude direct child frames before extraction.
truefalsequotedwith_shadow_domExpand open shadow roots before extraction.
truefalseBrowser
wait_untilNavigation event to wait for.
commitdomcontentloadedloadnetworkidlewait_for_selectorCSS selector to wait for after navigation, up to 2,048 characters.
Example / input hint: main
page_timeoutSeconds from 1 through 180 for browser operations.
Example / input hint: 30
localeBrowser locale, such as en-US.
Example / input hint: en-US
user_agentOptional User-Agent, up to 1,024 characters.
Example / input hint: Mozilla/5.0 …
// response
Work with the complete JSON response
Response groups include url, title, content, status_code. Groups and fields depend on the upstream result.
The SDK examples use raise_for_error() or raiseForError() so API errors are not mistaken for successful results.