API URL
GET /api/v1/web-screenshot
Headers
Code
Content-Type: application/jsonQuery Parameters
Param
Type
Description
url
required
string
Target website URL. Must include http/https
width
optional
number
Viewport width in pixels (100–3840). Default is 1280
height
optional
number
Viewport height in pixels (100–2160). Default is 800
format
optional
string
Image output format
quality
optional
number
JPEG quality (10–100). Default is 100
crop
optional
string
Crop output image to WIDTHxHEIGHT format (e.g., 800x600)
Example GET Request
Code
GET /api/v1/web-screenshot?url=https://example.com&width=1280&height=800&quality=90&crop=800x600Successful Response
Status
HTML
200 OKBody
Code
Returns a binary JPEG image representing the screenshot of the requested URL, sized to 800x600 pixels and encoded with JPEG quality 90.Field
Type
image_data
binary
content_type
string
content_length
number
x_correlation_id
string
x_processing_time
number
error
string
Error Response
Example
Code
- 400 INVALID_URL – If the URL is missing or invalid
- 400 INVALID_DIMENSIONS – If width, height, or crop values are invalid
- 500 CAPTURE_FAILED – If Puppeteer or rendering failsLast Updated: May 4, 2026