Skip to main content
POST
Screenshot a page

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string

Any unique string up to 255 visible characters. Send the same key when you retry a request: for 12 hours a repeat returns the first answer again, with an Idempotent-Replayed: true header, without doing the work or charging a second time. A repeat that arrives while the first is still running gets 409 IDEMPOTENCY_IN_PROGRESS; the same key with a different body gets 409 IDEMPOTENCY_KEY_REUSED.

Maximum string length: 255
Example:

"3f2b8c1e-retry-safe-key"

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
integer

Extra milliseconds to let the page settle before capture.

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

Overall time budget for the request, in milliseconds.

Required range: 1000 <= x <= 100000
maxAge
integer

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
integer

Exact viewport width in pixels. Overrides viewport.

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

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

Required range: 240 <= x <= 2160
dismissCookies
boolean

Accept cookie and consent banners before the capture. Default true. Set false to capture them.

dismissPopups
boolean

Clear popups and overlays covering the page before the capture. Default true. Set false to capture them.

Response

data
object
required