API Reference

All endpoints require an X-API-Key header. Get your API key from the dashboard.

For the full interactive API reference, visit api.rendershot.io/docs.

POST/v1/screenshot

Render a URL or HTML string to PNG or JPEG.

{
  "url": "https://example.com",
  "format": "png",
  "viewport": { "width": 1280, "height": 720 },
  "full_page": false,
  "wait_for": "network_idle",
  "ai_cleanup": "fast"
}

Returns raw image bytes with Content-Type: image/png or image/jpeg.

POST/v1/pdf

Render a URL or HTML string to PDF.

{
  "url": "https://example.com",
  "format": "A4",
  "orientation": "portrait",
  "print_background": true,
  "ai_cleanup": "fast"
}

Returns raw PDF bytes with Content-Type: application/pdf.