Options Reference

Use this as a complete map of request fields. Defaults apply when a field is omitted.

Input

Provide exactly one of:

• url (string)
• html (string)
• markdown (string)

Output

• response_type: json, binary, empty
• format: png, jpeg, webp, pdf
• quality: number (1-100, jpeg/webp)

Viewport

• viewport.width: number
• viewport.height: number
• viewport.device_scale_factor: number (1-3)
• viewport.is_mobile: boolean
• viewport.has_touch: boolean
• viewport.is_landscape: boolean
• viewport.device: string preset id

Full page

• full_page: boolean
• full_page_algorithm: auto, scroll, sections
• full_page_scroll_by: number (px)
• full_page_scroll_delay_ms: number (ms)
• full_page_max_height: number (px)

Capture (chunking)

• capture.mode: full, chunks, both
• capture.chunk_height: number (px)
• capture.chunk_overlap: number (px)
• capture.max_chunks: number

Wait

• wait.wait_until: array of load, domcontentloaded, networkidle
• wait.timeout_ms: number
• wait.navigation_timeout_ms: number
• wait.delay_ms: number
• wait.wait_for_selector: string
• wait.wait_for_function: string

Rendering

• reduce_motion: boolean
• media_type: screen, print
• dark_mode: boolean

Blocking

• block.ads: boolean
• block.trackers: boolean
• block.cookie_banners: boolean
• block.chats: boolean
• block.banners_by_heuristics: boolean
• block.resources: array of image, media, font, script, xhr, fetch, websocket, manifest, other
• block.requests: array of URL patterns

Customize

• customize.hide_selectors: array of CSS selectors
• customize.css: string
• customize.scripts: string
• customize.scripts_wait_until: array of load, domcontentloaded, networkidle

Auth

• auth.headers: array of Header: Value
• auth.cookies: array of name=value; Domain=...; Path=/; Secure; HttpOnly
• auth.proxy: string (http/https proxy URL)
• auth.user_agent: string
• auth.timezone: string
• auth.locale: string
• auth.basic_auth: { "username": string, "password": string }
• auth.bypass_csp: boolean

Storage

• storage.store: boolean
• storage.provider: s3, r2
• storage.bucket: string
• storage.path: string
• storage.public: boolean
• storage.expires_in: number (seconds)

Cache

• cache.enabled: boolean
• cache.ttl_seconds: number
• cache.key: string

Sticky elements

• sticky.mode: keep_once, hide, none
• sticky.selectors: array of CSS selectors

Debug

• debug.trace: boolean
• debug.har: boolean
• debug.console: boolean

Debug artifacts require storage.store: true.

Webhook (jobs only)

• webhook.url: string
• webhook.sign: boolean
• webhook.errors: boolean

Example

{
  "url": "https://example.com",
  "format": "jpeg",
  "quality": 80,
  "full_page": true,
  "viewport": { "width": 1280, "height": 720 },
  "block": { "ads": true, "trackers": true },
  "storage": { "store": true, "path": "captures/example" },
  "cache": { "enabled": true, "ttl_seconds": 86400 }
}