API Documentation

Everything you need to integrate SnapRender into your application.

Authentication

Pass your API key via the x-api-key header or Authorization: Bearer <key>.

curl -H "x-api-key: sr_live_YOUR_KEY" https://api.snaprender.dev/v1/...

POST/v1/screenshot

Capture a screenshot of any URL or raw HTML as PNG/JPEG.

urlstringURL to screenshot (required if html not provided)

htmlstringRaw HTML to render (required if url not provided)

formatstring"png" (default) or "jpeg"

widthnumberViewport width in px (default: 1280)

heightnumberViewport height in px (default: 720)

full_pagebooleanCapture full page scroll (default: false)

qualitynumberJPEG quality 0-100 (default: 80)

Binary image (image/png or image/jpeg)

Code	Meaning
400	Bad request — missing or invalid parameters
401	Unauthorized — invalid or missing API key
429	Rate limit exceeded or monthly quota reached (free plan)
500	Server error — rendering failed (timeout, invalid URL, etc.)