All options
The complete list of options for POST /screenshot (JSON body) and GET /screenshot (query parameters). For worked examples with pictures, see the Guides. Options marked Starter+, Pro+ or Scale require that plan — see plan-gated options.
Content
| Option | Type | Description |
|---|
url | string | Page to capture. |
html | string | Raw HTML to render instead of a URL. |
markdown | string | Markdown rendered to a styled page. |
selector | string | Capture only the matching element. See guide. |
Output
| Option | Type | Description |
|---|
format | string | png, jpeg, webp, pdf (pdf: Starter+). |
quality | number | 1–100 for jpeg/webp. |
fullPage | boolean | Capture the entire scrollable page. |
response | string | url (signed URL, default) or base64. |
Rendering
| Option | Type | Description |
|---|
viewport | object | { width, height, deviceScaleFactor, isMobile }. Pro+ for deviceScaleFactor > 1 or sizes above 1920×1080. |
device | string | Device preset, e.g. iPhone 14 Pro. |
orientation | string | portrait or landscape. |
darkMode / darkModeCSS / darkModeInvertImages | mixed | Dark rendering, with optional custom dark CSS. Starter+. |
geolocation / timezone / autoLocale | mixed | Location & locale spoofing. |
Waiting & timing
| Option | Type | Description |
|---|
waitFor | string | Wait for a selector before capturing. |
waitUntil | string | load, domcontentloaded, networkidle0/2. |
timeout | number | Navigation timeout, 1000–60000 ms. |
scrollDistance / scrollDelay / pauseAtViewport | mixed | Full-page scroll tuning for lazy-loading pages (defaults 100 px / 150 ms / true) — see scrolling screenshots. |
Blocking & modification
| Option | Type | Description |
|---|
blockAds / blockCookieBanners / blockChatWidgets / blockPopups | boolean | Content blocking. |
hideSelectors | string[] | Remove matching elements. Pro+. |
styles / scripts | string | Inject custom CSS (max 100KB) / JavaScript (max 50KB). Scale. |
waitAfterScript | number | Ms to wait after scripts run before capturing. |
interactions | array | click / scroll / hover / type / wait steps (max 50). Pro+. |
AI analysis
| Option | Type | Description |
|---|
ai.ocr | boolean | Extract all visible text from the capture. Pro+. |
ai.extract | object | { prompt, schema? } — structured data as JSON. Pro+. |
ai.analyze | object | { type?, prompt? } — general / seo / ux / accessibility review. Pro+. |
Each task is one AI call from the plan's monthly quota — see the AI analysis guide. Not supported for PDFs.
Caching & delivery
| Option | Type | Description |
|---|
cache / cacheTtl / forceRefresh | mixed | Caching controls. |
webhookUrl / webhookSecret | string | Async delivery — see guide. |