Capture screenshot
POST /snap/capture
POST
/snap/capture
Returns a PNG/JPG/WebP screenshot of any URL. Supports custom viewport, full page, and quality settings.
Request Body required
Section titled “Request Body required ”object
url
URL to capture (required)
string
width
Viewport width in pixels - affects responsive layout (default: 1920)
integer format: int32
height
Viewport height in pixels - ignored when fullPage=true (default: 1080)
integer format: int32
format
Output format: png, jpg, webp (default: png)
string
full_page
Capture full scrollable page (default: false)
boolean
quality
Image quality 0-100, only for jpg/webp (default: 80)
integer format: int32
locale
Browser locale, e.g. ‘en-US’, ‘fr-FR’ (default: en-US)
string
Responses
Section titled “ Responses ”string format: binary
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
key
additional properties
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
key
additional properties