Documentation

Authentication

Create an API key from your dashboard, then send it in the X-API-Key header:

curl -X POST https://shotforge.dev/api/v1/screenshot \
  -H "X-API-Key: sk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}' --output shot.png

POST/api/v1/screenshot

Render a URL to PNG or JPEG.

🔒 Authenticated pages

Screenshot pages behind a login. Send an optional auth object with your screenshot request — credentials are used once in-memory to render, never stored or logged. Starter plan and above.

curl -X POST https://shotforge.dev/api/v1/screenshot \
  -H "X-API-Key: sk_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://app.example.com/dashboard",
    "auth": {
      "username": "you@example.com",
      "password": "secret",
      "type": "basic"
    }
  }' --output private-page.png

Security: credentials transit over TLS, live only for the duration of the render in an isolated browser context, and are discarded when it closes. They never appear in logs, the database, or usage history (only the target URL is recorded).

POST/api/v1/og-image

Render a 1200×630 social card (PNG).

template — raw (legacy viewport capture) or one of 60 composed template IDs. Composed cards are always 1200×630.

title, subtitle, brand — Optional title (120 chars), subtitle (220) and brand (60) for composed templates.

OG Creator →

POST/api/v1/pdf

Render a URL to PDF. Pro plan and above. Fields: url, format (A4|A3|Letter|Legal), landscape, print_background.

Errors