Skip to main content
All options are passed as JSON in the body of POST /v1/screenshots. Only url is required.

​
url

The page to capture. Must be a valid, publicly reachable URL.

​
format

Requesting webp on the Free plan returns 400.

​
width / height

Values above your plan’s ceiling return 400 rather than being silently clamped — set them explicitly only when you need something other than the default.

​
full_page

Captures the entire scrollable page instead of just the viewport defined by width/height.

​
quality

Compression quality, used for jpeg and webp output. Ignored for png.

​
fresh

Bypasses the result cache and forces a new render. See Caching & fresh for when you’d want this.

​
What’s not exposed yet

Device scale factor (rendering at a higher pixel density, e.g. for retina screenshots) is part of the Pro plan’s feature set but isn’t yet an accepted request parameter — every capture currently renders at a fixed scale server-side. If you need this, mention it when you sign up; it’s on the near-term roadmap.