Quickstart

Render your first screenshot in one call. The examples below use http://localhost:8080 — swap in your FrameShot host.

curl -X POST http://localhost:8080/v1/screenshot \
  -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","format":"png","width":1280}' \
  -o shot.png
# PNG bytes, Content-Type: image/png

curl -X POST http://localhost:8080/v1/pdf \
  -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"url":"https://example.com"}' -o page.pdf
# Print-ready A4 PDF, backgrounds included

curl -X POST http://localhost:8080/v1/screenshot \
  -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","format":"webp",
      "webhook_url":"https://your.app/hooks/frameshot"}' -o shot.webp
# Your callback receives:
# {"event":"render.completed","url":"...","format":"webp",
#  "bytes":184320,"sha256":"9f2c..."}
# Verify X-FrameShot-Signature = HMAC-SHA256(api_key, raw_body)

Pick a plan