List Presets

Retrieve all available screenshot presets with their configurations.

Endpoint

GET https://api.renderscreenshot.com/v1/presets

Authentication

Include your API key in the Authorization header:

Authorization: Bearer rs_live_xxxxx

Response

{
  "presets": [
    {
      "id": "og_card",
      "name": "Open Graph Card",
      "description": "1200x630 PNG optimized for Facebook, LinkedIn, etc.",
      "config": {
        "viewport": { "width": 1200, "height": 630 },
        "output": { "format": "png" },
        "cache": { "ttl": 86400 }
      }
    },
    {
      "id": "twitter_card",
      "name": "Twitter Card",
      "description": "1200x600 PNG optimized for Twitter",
      "config": {
        "viewport": { "width": 1200, "height": 600 },
        "output": { "format": "png" },
        "cache": { "ttl": 86400 }
      }
    },
    {
      "id": "twitter_card_large",
      "name": "Twitter Large Card",
      "description": "1200x628 PNG for Twitter summary_large_image",
      "config": {
        "viewport": { "width": 1200, "height": 628 },
        "output": { "format": "png" },
        "cache": { "ttl": 86400 }
      }
    },
    {
      "id": "full_page",
      "name": "Full Page Screenshot",
      "description": "Captures entire scrollable page",
      "config": {
        "capture": {
          "mode": "full_page",
          "scroll": { "simulate": true, "delay": 400 }
        },
        "cache": { "ttl": 3600 }
      }
    },
    {
      "id": "pdf_document",
      "name": "PDF Document",
      "description": "Print-ready A4 PDF",
      "config": {
        "output": { "format": "pdf" },
        "pdf": { "paper": "a4", "background": true }
      }
    },
    {
      "id": "mobile",
      "name": "Mobile Screenshot",
      "description": "iPhone 14 Pro viewport",
      "config": {
        "viewport": { "device": "iphone_14_pro" }
      }
    },
    {
      "id": "mobile_landscape",
      "name": "Mobile Landscape",
      "description": "Mobile device in landscape orientation",
      "config": {
        "viewport": { "device": "iphone_14_pro", "landscape": true }
      }
    },
    {
      "id": "desktop_hd",
      "name": "Desktop HD",
      "description": "1920x1080 Full HD desktop",
      "config": {
        "viewport": { "width": 1920, "height": 1080 }
      }
    },
    {
      "id": "desktop_4k",
      "name": "Desktop 4K",
      "description": "3840x2160 4K desktop",
      "config": {
        "viewport": { "width": 3840, "height": 2160 }
      }
    },
    {
      "id": "link_preview",
      "name": "Link Preview",
      "description": "800x600 for chat previews with metadata",
      "config": {
        "viewport": { "width": 800, "height": 600 },
        "metadata": { "include": ["title", "description", "favicon"] }
      }
    }
  ]
}

Using Presets

Specify a preset in your screenshot request:

POST Request

{
  "url": "https://example.com",
  "preset": "og_card"
}

GET Request

GET /v1/screenshot?url=https://example.com&preset=og_card

Overriding Preset Values

Presets provide sensible defaults. You can override any value:

{
  "url": "https://example.com",
  "preset": "og_card",
  "output": { "format": "webp" }
}

This uses the og_card viewport (1200x630) but outputs WebP instead of PNG.

Example

curl https://api.renderscreenshot.com/v1/presets \
  -H "Authorization: Bearer rs_live_xxxxx"