Presets Reference

Presets provide pre-configured settings for common screenshot use cases. Use a preset to get sensible defaults, then override specific values as needed.

Using Presets

POST Request

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

GET Request

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

Override Preset Values

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

og_card

Open Graph social cards optimized for Facebook, LinkedIn, Discord, Slack, and other platforms.

Setting Value
Viewport 1200 × 630
Format PNG
Cache TTL 24 hours
{
  "viewport": { "width": 1200, "height": 630 },
  "output": { "format": "png" },
  "cache": { "ttl": 86400 }
}

Use for: - og:image meta tags - Link previews on social platforms - Blog post sharing images


twitter_card

Twitter summary cards for standard Twitter sharing.

Setting Value
Viewport 1200 × 600
Format PNG
Cache TTL 24 hours
{
  "viewport": { "width": 1200, "height": 600 },
  "output": { "format": "png" },
  "cache": { "ttl": 86400 }
}

Use for: - twitter:image meta tags - Twitter summary cards


twittercardlarge

Twitter large summary cards with the summary_large_image card type.

Setting Value
Viewport 1200 × 628
Format PNG
Cache TTL 24 hours
{
  "viewport": { "width": 1200, "height": 628 },
  "output": { "format": "png" },
  "cache": { "ttl": 86400 }
}

Use for: - Twitter summary_large_image cards - Prominent visual sharing


link_preview

Link previews for chat apps and messaging platforms.

Setting Value
Viewport 800 × 600
Format PNG
Metadata title, description, favicon
{
  "viewport": { "width": 800, "height": 600 },
  "output": { "format": "png" },
  "metadata": { "include": ["title", "description", "favicon"] }
}

Use for: - Chat app link previews - Messaging platform embeds - URL cards with metadata


full_page

Full page screenshots capturing the entire scrollable content.

Setting Value
Capture Full page with scroll simulation
Scroll delay 400ms
Cache TTL 1 hour
{
  "capture": {
    "mode": "full_page",
    "scroll": { "simulate": true, "delay": 400 }
  },
  "cache": { "ttl": 3600 }
}

Use for: - Documentation screenshots - Full article captures - Design reviews - Archiving web pages


pdf_document

Print-ready PDF documents in A4 format.

Setting Value
Format PDF
Paper A4
Background Enabled
{
  "output": { "format": "pdf" },
  "pdf": { "paper": "a4", "background": true }
}

Use for: - Printable reports - Document exports - Invoice generation


mobile

Mobile screenshots using iPhone 14 Pro dimensions.

Setting Value
Device iPhone 14 Pro
Viewport 390 × 844
Scale 3x
Mobile true
Touch true
{
  "viewport": { "device": "iphone_14_pro" }
}

Use for: - Mobile app store screenshots - Responsive design testing - Mobile-specific features


mobile_landscape

Mobile landscape screenshots for horizontal mobile views.

Setting Value
Device iPhone 14 Pro (landscape)
Viewport 844 × 390
Scale 3x
Mobile true
{
  "viewport": { "device": "iphone_14_pro", "landscape": true }
}

Use for: - Landscape mobile content - Video player screenshots - Horizontal app layouts


desktop_hd

Full HD desktop screenshots at 1920×1080.

Setting Value
Viewport 1920 × 1080
Format PNG
{
  "viewport": { "width": 1920, "height": 1080 },
  "output": { "format": "png" }
}

Use for: - Desktop application screenshots - Full HD presentations - High-resolution captures


desktop_4k

4K ultra-high-definition screenshots at 3840×2160.

Setting Value
Viewport 3840 × 2160
Format PNG
{
  "viewport": { "width": 3840, "height": 2160 },
  "output": { "format": "png" }
}

Use for: - 4K displays - Print-quality images - High-DPI presentations


Preset Comparison

Preset Viewport Format Best For
og_card 1200×630 PNG Social sharing
twitter_card 1200×600 PNG Twitter
twitter_card_large 1200×628 PNG Twitter large
link_preview 800×600 PNG Chat previews
full_page 1280×800+ PNG Full captures
pdf_document A4 PDF Documents
mobile 390×844 PNG Mobile testing
mobile_landscape 844×390 PNG Landscape mobile
desktop_hd 1920×1080 PNG HD desktop
desktop_4k 3840×2160 PNG 4K desktop

See Also

Was this page helpful?