FeaturePOST /v1/screenshot

Website Screenshot API

Repeatable screenshot evidence: viewport, full-page, or multi-viewport — as PNG or JSON with metadata.

What you can do with screenshots

Scout opens a URL in a real browser and delivers visual evidence — as an image, JSON with Base64, or multiple breakpoints in one call. Ideal for QA, visual regression, and alert attachments.

Viewport or full-page shots as PNG/JPEG/PDF
JSON with metadata and optional image content
Multiple viewports (desktop/tablet/mobile) in one request
Pixel diff against a reference PNG for visual regression

API Call

editable

Request body

{'{'}

:"jpeg"

{'}'}

Click values to edit. Click mode to switch between viewport and fullpage.

Response

No screenshot yet — choose an endpoint and run

Endpoints & parameters

Choose an endpoint — below you'll see an example request and explanations for all relevant parameters.

POST /v1/screenshot

Returns the screenshot directly as binary (image/* or PDF), not as JSON.

Example request

json

{
  "url": "https://example.com",
  "mode": "viewport",
  "width": 1280,
  "height": 800,
  "wait_ms": 500,
  "format": "jpeg",
  "quality": 82,
  "dismiss_cookie_banner": true
}

Parameters

urlstring required
Target URL that Scout opens in the browser.
mode'viewport'|'fullpage'
Visible viewport or entire page. Default: fullpage.
widthnumber
Viewport width in px (200–3840). Default: 1280.
heightnumber
Viewport height in px (200–2160). Default: 800.
max_page_heightnumber
Upper limit for full-page height.
wait_msnumber
Wait time after load before capture (0–30000).
format'jpeg'|'png'|'pdf'
Output format. Default: jpeg.
qualitynumber
JPEG quality 1–100.
dismiss_cookie_bannerboolean
Attempts to dismiss known cookie banners before measuring or checking.
wait_for_selectorstring
Waits for a CSS selector before continuing.
wait_ms / settle_msnumber
Additional wait time after loading (depends on endpoint).
devicestring
Playwright device preset; overrides width/height/UA when set.
color_scheme'light'|'dark'|'no-preference'
Preferred color scheme in the browser.
block_adsboolean
Blocks known ad and tracker requests.
capture_xhrstring
Glob or substring for XHR/fetch URLs whose bodies Scout captures (max. 20).
fetch_mode'browser'|'http'
http loads without JavaScript (static document). Default: browser.
solve_captchaboolean
Best-effort Turnstile/checkbox on your own sites. Cloud: domain verify. Self-host: always allowed.
record_harboolean
Optionally records HAR (where supported by the endpoint).
respect_robotsboolean
Respect robots.txt (default: on).