Introduction

RenderScreenshot is the screenshot API for developers. Capture any web page programmatically with a simple API call.

Overview

RenderScreenshot provides a reliable, fast API for capturing screenshots of web pages. Use it for:

  • Social cards - Dynamic og:image for Twitter, LinkedIn, and Slack
  • Documentation - Automated UI screenshots that stay up to date
  • Visual testing - Catch UI regressions in your CI/CD pipeline
  • PDF generation - Convert web pages to PDF documents
  • Link previews - Rich previews for messaging apps

Quick Example

Capture a screenshot with a single API call:

curl -X POST https://api.renderscreenshot.com/v1/screenshot \
  -H "Authorization: Bearer rs_live_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "preset": "og_card"
  }'

Or use it directly in your HTML:

<meta property="og:image"
      content="https://api.renderscreenshot.com/v1/screenshot?url=https://yoursite.com&preset=og_card&api_key=rs_live_xxxxx" />

How It Works

Your App → RenderScreenshot API → Cloudflare Worker → Screenshot
                ↓                                         ↓
         (auth, caching,                           (stored on CDN)
          rate limiting)
  1. Your app sends a screenshot request to our API
  2. We authenticate the request and check our cache
  3. If not cached, our Cloudflare Worker renders the page
  4. The screenshot is stored on our global CDN
  5. Subsequent requests are served from cache

Features

  • Fast - Screenshots in under 2 seconds, cached globally
  • Presets - og_card, twitter_card, full_page in one parameter
  • Secure - Signed URLs with expiration, keys never exposed
  • Clean output - Block ads, popups, and cookie banners
  • Full control - Custom viewport, wait conditions, element selectors

Getting Started

API Reference

References

Was this page helpful?