FeaturePOST /v1/screenshot

Website Screenshot API

Scout liefert Screenshot-Evidence für wiederholbare Checks. Viewport, Full-Page oder Multi-Viewport — als PNG oder JSON mit Metadaten.

Docs öffnen Pricing

Was du mit Screenshots machen kannst

Scout öffnet eine URL im echten Browser und liefert visuelle Evidence — als Bild, JSON mit Base64 oder mehrere Breakpoints in einem Call. Ideal für QA, visuelle Regression und Alert-Anhänge.

Viewport- oder Full-Page-Shots als PNG/JPEG/PDF
JSON mit Metadaten und optionalem Bildinhalt
Mehrere Viewports (Desktop/Tablet/Mobile) in einem Request
Pixel-Diff gegen eine Referenz-PNG für visuelle Regression

API Call

editable

Request body

{'{'}

:"jpeg"

{'}'}

Klicke auf Werte zum Bearbeiten. mode wechselt per Klick zwischen viewport und fullpage.

Response

Noch kein Screenshot — Endpoint wählen und Ausführen

Endpoints & Parameter

Endpoint wählen — darunter siehst du eine beispielhafte Anfrage und die Erklärung aller relevanten Parameter.

POST /v1/screenshot

Liefert den Screenshot direkt als Binary (image/* oder PDF), nicht als JSON.

Beispiel-Anfrage

json

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

Parameter

urlstring required
Ziel-URL, die Scout im Browser öffnet.
mode'viewport'|'fullpage'
Sichtbarer Ausschnitt oder ganze Seite. Default: fullpage.
widthnumber
Viewport-Breite in px (200–3840). Default: 1280.
heightnumber
Viewport-Höhe in px (200–2160). Default: 800.
max_page_heightnumber
Obergrenze für Full-Page-Höhe.
wait_msnumber
Wartezeit nach dem Laden vor dem Shot (0–30000).
format'jpeg'|'png'|'pdf'
Ausgabeformat. Default: jpeg.
qualitynumber
JPEG-Qualität 1–100.
dismiss_cookie_bannerboolean
Versucht bekannte Cookie-Banner zu schließen, bevor gemessen/geprüft wird.
wait_for_selectorstring
Wartet auf CSS-Selector, bevor weitergemacht wird.
wait_ms / settle_msnumber
Zusätzliche Wartezeit nach dem Laden (je nach Endpoint).
devicestring
Playwright-Device-Preset; überschreibt width/height/UA wenn gesetzt.
color_scheme'light'|'dark'|'no-preference'
Bevorzugtes Farbschema im Browser.
block_adsboolean
Blockiert bekannte Ad-/Tracker-Requests.
record_harboolean
Zeichnet optional HAR auf (wo vom Endpoint unterstützt).
respect_robotsboolean
Robots.txt beachten (Default: an).