Screenshot route body parameters

To render a screenshot, set screenshot under the page property:

screenshot properties for screenshot routes

These properties follow Puppeteer's ScreenshotOptions type.

Property name	Type	Description
captureBeyondViewport	boolean	Captures the screenshot beyond the visible 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	Image quality, between 0 and 100. Not applicable to PNG images. optional
type	'png', 'jpg', 'jpeg', 'webp'	Image format, default is png. optional

⚠️ WARNING

• clip and fullPage cannot be used at the same time. They are mutually exclusive.
• quality cannot be used with the PNG format.
• If you define quality, you must also set type to jpg, jpeg, or webp.

clip properties

Property name	Type	Description
width	number	Width of the area to capture.
height	number	Height of the area to capture.
x	number	X coordinate of the capture area.
y	number	Y coordinate of the capture area.