Render

Screenshot API

Capture high-fidelity screenshots in PNG, JPEG, or WebP formats using headless Chromium with custom viewports, device scale factors, and wait delays.

POST/v1/render/screenshotCost: 1 Credit

Request Parameters

FieldTypeDefaultDescription
urlstring (required)-Target web address (must be http or https)
formatstring"png"Image format: png, jpeg, webp
full_pagebooleantrueCapture entire scrollable page height
widthinteger1440Viewport width in pixels (320 - 3840)
heightinteger900Viewport height in pixels (240 - 2160)
device_scale_factornumber1Pixel density multiplier (e.g. 2 for Retina)
delay_msinteger0Milliseconds to wait after load before capture

Code Example

curl -X POST https://api-rendernest.duckdns.org/v1/render/screenshot \
  -H "Authorization: Bearer wf_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "format": "png",
    "full_page": true,
    "width": 1440,
    "height": 900
  }'

Response Example

{
  "success": true,
  "request_id": "req_1725432120_8a7c2b",
  "data": {
    "url": "https://example.com",
    "format": "png",
    "file_url": "https://api-rendernest.duckdns.org/api/storage/screenshots/ws_demo/req_1725432120_8a7c2b.png?expires=1726036920&signature=...",
    "width": 1440,
    "height": 900,
    "file_size_bytes": 148291
  }
}