Parameters

All parameters are sent as JSON in the request body.

Required Parameters

Parameter	Type	Description
url	string	The URL to capture. Must be a valid HTTP or HTTPS URL.

Output Options

Parameter	Type	Default	Description
format	string	"png"	Output format: png, jpeg, webp, or pdf
quality	integer	80	Image quality from 1-100. Only applies to JPEG and WebP formats.
fullPage	boolean	false	Capture the full scrollable page instead of just the viewport.

Viewport Options

Parameter	Type	Default	Description
device	string	"desktop"	Device profile preset. See Device Profiles.
width	integer	1920	Viewport width in pixels (1-4096). Overrides device preset.
height	integer	1080	Viewport height in pixels (1-4096). Overrides device preset.
scale	integer	1	Device scale factor (1-3). Use 2 or 3 for retina displays.

Content Blocking

Parameter	Type	Default	Description
hideCookieBanners	boolean	true	Automatically hide cookie consent banners.
hidePopups	boolean	false	Hide popup dialogs, modals, and chat widgets.
aggressivePopupRemoval	boolean	false	More aggressive popup and overlay removal. May break some pages.
blockAds	boolean	false	Block advertisements and ad network scripts.
blockRequests	array	[]	Array of URL patterns to block. Comma-separated patterns.

Example

{
  "url": "https://example.com",
  "format": "webp",
  "quality": 90,
  "fullPage": true,
  "device": "iphone-15-pro",
  "scale": 2,
  "hideCookieBanners": true,
  "blockAds": true,
  "blockRequests": ["*google-analytics*"]
}