Gallery — API Options

API option reference

Every API control you can pass to POST /v1/capture, grouped by what it affects: output dimensions, file format, device rendering, and page-cleanup options.

Option groups

  • Output — aspect_ratio, output.width, output.height, output.format (png, webp, jpeg, avif), output.quality, output.dpr.
  • Device rendering — device, device_color, viewport, capture_dpr, user_agent, emulate_mobile, emulate_touch.
  • Page cleanup — hide_selectors, block_ads, block_cookie_banners, dark_mode, wait_for.
  • Async — async: true with webhook_url for fire-and-forget rendering.
  • Auth — auth_profile_id to capture pages behind a login wall.