Skip to main content
POST
Screenshot a page

Authorizations

X-API-Key
string
header
required

Body

application/json
url
string
required

The URL to screenshot. Must be http(s).

Example:

"https://example.com"

fullPage
boolean

Capture the entire scrollable page instead of just the viewport. Default off.

Example:

true

waitFor
number

Extra milliseconds to let the page settle before capture.

Required range: 0 <= x <= 30000
timeout
number

Overall time budget for the request, in milliseconds.

Required range: 1000 <= x <= 120000
maxAge
number

Reuse a stored screenshot if it is younger than this many milliseconds. Defaults to 7 days, so a repeated request returns the stored PNG with cached: true without re-rendering — which also means it returns immediately and does not apply waitFor. Pass 0 to force a fresh capture.

Required range: x >= 0
viewport
enum<string>

Screen size to render at. Defaults to desktop (1920x1080). Ignored when width/height are given explicitly.

Available options:
desktop,
laptop,
tablet,
mobile
Example:

"desktop"

viewportWidth
number

Exact viewport width in pixels. Overrides viewport.

Required range: 320 <= x <= 3840
viewportHeight
number

Exact viewport height in pixels. Overrides viewport. With fullPage the capture still extends to the full page height.

Required range: 240 <= x <= 2160

Response

200 - application/json
data
object
required