On this page

Screenshot Routes body params

To render a screenshot, you can set screenshot under page property:

For the screenshot route `screenshot` properties follow the ScreenshotOptions type

Property name	Type	Description
`captureBeyondViewport`	boolean	Capture the screenshot beyond the viewport. `optional`
`clip`	`ScreenshotClip`	An object which specifies the clipping region of the page. `optional`
`fullPage`	boolean	When true, takes a screenshot of the full page. `optional`
`omitBackground`	boolean	Hides default white background and allows capturing screenshots with transparency. `optional`
`quality`	number	Quality of the image, between `0-100`. Not applicable to png images. `optional`
`type`	'png', 'jpg', 'jpeg', 'webp'	Image format, default is `png`. `optional`

⚠️ WARNING

clip and fullPage properties can't be use in same time, they are mutually exclusive.
quality param and type param for PNG format are incompatible.
If you define quality param, you need to define type param for jpg, jpeg or webp.

`clip` properties:

Property name	Type	Description
`width`	number	The width of page to capture.
`height`	number	The height of page to capture.
`x`	number	X coordinate to capture.
`y`	number	Y coordinate to capture.