Capture a URL

Minimal request

{
  "url": "https://example.com",
  "format": "png",
  "full_page": true
}

Output options

{
  "url": "https://example.com",
  "response_type": "binary",
  "format": "webp"
}

{
  "url": "https://example.com",
  "response_type": "empty",
  "storage": { "store": true, "path": "captures/example" }
}

Viewport control

{
  "url": "https://example.com",
  "viewport": {
    "width": 1280,
    "height": 720,
    "device_scale_factor": 2
  }
}

{
  "url": "https://example.com",
  "viewport": { "device": "iphone-14" }
}

Timing controls

{
  "url": "https://example.com",
  "wait": {
    "wait_until": ["domcontentloaded"],
    "wait_for_selector": "#pricing",
    "timeout_ms": 45000
  }
}

Noise reduction

{
  "url": "https://example.com",
  "block": {
    "ads": true,
    "trackers": true,
    "cookie_banners": true,
    "chats": true
  }
}

Customization

{
  "url": "https://example.com",
  "customize": {
    "hide_selectors": [".cookie-banner", ".promo"]
  }
}

{
  "url": "https://example.com",
  "customize": {
    "css": "header{display:none}"
  }
}

Storage and caching

{
  "url": "https://example.com",
  "storage": { "store": true, "path": "captures/homepage" },
  "cache": { "enabled": true, "ttl_seconds": 86400 }
}

See Options reference for the full list.

Common errors

• invalid_url: URL is malformed or unsupported.
• ssrf_blocked: URL failed SSRF protection.
• timeout_error: render exceeded wait.timeout_ms.
• navigation_timeout: target did not respond fast enough.