// request reference
Screenshot parameters
Send query parameters with GET /api/web/screenshot. 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.
Screenshot
Capture a PNG and receive its authenticated download URL.
urlPublic http:// or https:// URL, up to 8,192 characters, with a standard port and no credentials.
Example / input hint: https://litescrape.com
full_pageCapture the full page when true. The default captures the viewport.
truefalseBrowser
For custom cookies, viewport dimensions and scripts, send a POST request with a JSON body. See the Screenshot API reference.
respond_timingPage readiness condition before responding.
htmlvisible-contentmutation-idleresource-idlemedia-idlenetwork-idlewait_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 …
refererOptional HTTP(S) referer.
Example / input hint: https://example.com
remove_overlayRemove cookie banners and modal overlays before capture.
truefalsedetach_invisiblesDrop display:none elements before capture.
truefalseassert_status_codeRequire this origin HTTP status, from 100 through 599.
Example / input hint: 200
robots_txtCheck robots.txt for this user agent and reject disallowed URLs.
Example / input hint: MyBot
// response
Work with the complete JSON response
Response groups include url, title, screenshot_url, full_page. 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.