Every option the screenshot endpoint accepts, grouped by what it controls. Each parameter has its own page with accepted values and a working example.
The URL of the webpage to capture. Either url or html must be provided, but not both.
Raw HTML content to render and capture. Useful for generating images from dynamic content or templates. Either url or h…
The output image format. Defaults to image/png.
How the screenshot should be returned: - image (default): Returns the raw image binary data with appropriate Content-Ty…
The width of the browser viewport in pixels. This determines the width of the rendered page. Maximum value is 3840 pixe…
The height of the browser viewport in pixels. This affects the visible area before scrolling. Maximum value is 3840 pix…
Quick viewport size preset for common devices. If specified, this sets both viewport_width and viewport_height automati…
The device scale factor (pixel density) to use when rendering the page. A value of 2 simulates a Retina display, produc…
The X coordinate (in pixels) of the top-left corner of the crop region. Use together with crop_y, crop_width, and crop_…
The Y coordinate (in pixels) of the top-left corner of the crop region. Use together with crop_x, crop_width, and crop_…
The width (in pixels) of the crop region. Use together with crop_x, crop_y, and crop_height to capture a specific porti…
The height (in pixels) of the crop region. Use together with crop_x, crop_y, and crop_width to capture a specific porti…
A CSS selector to identify a specific element to screenshot. Only the matching element will be captured, ignoring the r…
When true, captures the entire scrollable page content, not just the visible viewport. When false, only captures the vi…
When true, makes the background transparent (only works with PNG format). Useful for capturing elements that you want t…
When true, scrolls the page to the bottom before taking the screenshot. This is useful for triggering lazy-loaded conte…
When true, generates a print-ready PDF version of the page (as if using the browser's print dialog). This option forces…
Custom User-Agent string to use when loading the page. Useful for accessing mobile versions of sites or bypassing basic…
When true, blocks ads and trackers for a cleaner screenshot. This can also speed up page loading.
When true, automatically detects and removes cookie consent banners and GDPR popups from the page before taking the scr…
Controls the color scheme preference for the page: - default: Use the page's default color scheme - light: Force light …
The language code to set for the browser. This affects the Accept-Language header and the navigator.language property i…
