Guide

Screenshot API Use Cases: 25 Practical Examples

25 screenshot API use cases with working request bodies, plan requirements and honest limits.

Asad AliSeptember 25, 202512 min read

A screenshot API does one thing: it opens a URL in a real browser on a server and gives you back what it rendered. That simple primitive shows up in a surprising number of products and internal workflows.

This list covers 25 of them. For each one you get the request body, the plan it needs, and the part you still have to build yourself. Every body below is checked against the current Screenshotly request schema, which rejects unknown fields.

The request every example uses

All examples send a JSON body to one endpoint, from your server:

// Node.js 18+ (built-in fetch). Keep the key on the server.
async function capture(body) {
  const response = await fetch('https://screenshotly.app/api/screenshot', {
    method: 'POST',
    headers: {
      'x-api-key': process.env.SCREENSHOTLY_API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(body),
  });
  if (!response.ok) {
    const error = await response.json(); // { error, message, ... }
    throw new Error(`${response.status} ${error.error}: ${error.message ?? ''}`);
  }
  return Buffer.from(await response.arrayBuffer()); // image, PDF, HTML or WebM bytes
}

A few facts that apply everywhere:

  • Viewport: top-level width (320–3840) and height (240–3840), or a device preset: desktop 1920 × 1080, laptop 1366 × 768, tablet 768 × 1024, mobile 375 × 812. There is no nested viewport object.
  • Browser: Chromium only. Screenshotly does not render in Firefox or Safari.
  • Input: a URL. There is no raw-HTML input. To render your own template, host it at a URL first.
  • Output: the response body is the file. To get a link instead, Basic plans can send "storage": { "enabled": true } and receive JSON with a signed URL that works for 24 hours. For anything public and long-lived, such as an og:image, copy the file to your own storage or CDN.
  • Failures return JSON errors and do not count against your quota.

Content and publishing

Show a visual card when users paste a URL into your app, chat or CMS.

{ "url": "https://example.com/article", "width": 1200, "height": 630, "format": "jpeg", "quality": 80, "blockAds": true }

Plan: Free. You build: title and description extraction, and caching so the same URL isn't captured on every paste. See the link preview guide.

2. Blog and article thumbnails

Generate a consistent featured image from the live article when nobody designed one.

{ "url": "https://yourblog.com/posts/launch-notes", "width": 1280, "height": 720, "format": "webp", "quality": 80 }

Plan: Free. Note: viewport captures skip web-font downloads to stay fast, so headings may render in a fallback font. If typography matters, use a template page built for the thumbnail (see #13).

Give each curated link a small visual preview in your weekly email.

{ "url": "https://example.com/curated-link", "device": "desktop", "format": "jpeg", "quality": 70 }

Plan: Free. You build: resizing to your email template width and hosting the images. Email clients need a public image URL.

4. Content archival

Keep a dated visual record of a page, for research, editorial history or your own site's past versions.

{ "url": "https://example.com/announcement", "fullPage": true, "format": "png" }

Plan: Free for images. PDF output ("format": "pdf") needs Basic and always prints on A4 with 1 cm margins. You build: storage, file naming and retention. See the archival and compliance guide.

E-commerce

5. Competitor product page tracking

Capture competitor product pages on a schedule so a person can review changes.

{ "url": "https://competitor.example/product/123", "fullPage": true, "blockAds": true, "waitForNetworkIdle": true }

Plan: Free. stealth: true (a standard desktop user agent plus common anti-automation tweaks) needs Basic and does not get past every bot check. You build: the schedule, image comparison and alerts. Check each site's terms before monitoring it.

6. Directory and search-result previews

Show what each listed website looks like before a visitor clicks.

{ "url": "https://listed-site.example", "width": 1280, "height": 800, "format": "webp", "quality": 75 }

Plan: Free. You build: a refresh schedule (weekly or monthly is usually enough) and a placeholder for sites that fail.

7. Marketplace and agency listings

Show each seller's or agency's website on their profile.

{ "url": "https://seller.example", "device": "desktop", "format": "jpeg", "quality": 80, "blockAds": true }

Plan: Free. Note: a screenshot shows what a site looks like. It is not a check that the business is legitimate.

8. Pricing page records for comparison sites

Keep a dated capture of each vendor's pricing page next to the figures you publish.

{ "url": "https://vendor.example/pricing", "fullPage": true, "format": "png", "waitForNetworkIdle": true }

Plan: Free. You build: the comparison table itself. The screenshot is the evidence behind it, and the date belongs in your file name or database.

Development and QA

9. Visual regression baselines

Capture key pages after each deploy and compare them with the last known good version.

{ "url": "https://staging.example.com/checkout", "width": 1440, "height": 900, "fullPage": true, "waitForNetworkIdle": true }

Plan: Free for public staging URLs. Basic adds cookies or headers for protected staging. You build: the image diff (for example with pixelmatch), the baseline store and CI integration. See the visual regression testing guide.

10. Responsive layout checks

Capture the same page at several widths to spot broken breakpoints.

{ "url": "https://example.com", "device": "mobile", "fullPage": true }

Repeat with "device": "tablet" and "device": "desktop", or exact width values for your breakpoints. Plan: Free. Limit: this checks layouts in Chromium at different viewport sizes. It is not cross-browser testing, and there is no Safari or Firefox rendering.

11. Documentation screenshots

Regenerate product screenshots for docs whenever the UI changes, instead of retaking them by hand.

{ "url": "https://app.example.com/settings/billing", "width": 1440, "height": 900, "selector": "#billing-panel", "cookies": [{ "name": "session", "value": "SESSION_VALUE", "domain": "app.example.com" }] }

Plan: Basic (for cookies). selector captures a single element on any plan. You build: a docs or demo account, a CI job that refreshes the images, and a review step. See the documentation automation guide.

12. Status and error page snapshots

When an uptime monitor flags a public URL, capture what visitors see right then and attach it to the incident.

{ "url": "https://example.com/checkout", "device": "desktop", "fullPage": true }

Plan: Free. Limit: the API opens the URL in a fresh browser. It cannot capture the state of your test runner's browser or a user's session, so use your test framework's own screenshot feature for failed test steps.

Marketing and sales

13. Social cards from a template page

Build a 1200 × 630 HTML template for your posts, then capture it to produce the og:image.

{ "url": "https://example.com/og-template?slug=launch-notes", "width": 1200, "height": 630, "format": "png", "deviceScaleFactor": 2 }

Plan: Free. You build: the template page and a step that stores the image at a public URL. Social networks fetch og:image themselves, so they cannot use an API response that needs your key. See the dynamic OG image guide.

14. Case study visuals in a device frame

Capture a customer's live site and place it in a laptop frame for a case study.

{ "url": "https://customer-site.example", "device": "desktop", "mockup": "macbook-pro", "aiRemoval": { "enabled": true, "types": ["cookie-banner", "chat-widget"] } }

Plan: Growth (mockups and AI element removal). The available mockups are browser-light, browser-dark, browser-minimal, iphone-14, ipad-pro and macbook-pro. Get the customer's permission before publishing their site.

15. Competitor messaging reviews

Capture competitors' homepages and feature pages each quarter so positioning reviews start from evidence.

{ "url": "https://competitor.example/features", "fullPage": true, "blockAds": true }

Plan: Free. blockAds blocks requests to known ad domains and hides common ad and cookie-banner elements by CSS selector. It is not a complete ad blocker.

16. Portfolio showcases

Show client work in browser and phone frames.

{ "url": "https://client-site.example", "device": "mobile", "mockup": "iphone-14" }

For the desktop version, send "device": "desktop", "mockup": "browser-dark". Plan: Growth. See device mockups for marketing.

Business operations

17. Invoices from a hosted page

Render each invoice as a web page in your app, then capture it as a PDF.

{ "url": "https://app.example.com/invoices/INV-2026-001/print", "format": "pdf", "headers": { "Authorization": "Bearer SHORT_LIVED_TOKEN" } }

Plan: Basic (PDF and headers). Limit: PDFs always print on A4 with 1 cm margins and background graphics. Letter size, landscape and custom headers or footers are not available, so control the layout with print CSS. See the invoice PDF guide.

18. Dashboard reports

Turn a dashboard into a monthly PDF for stakeholders who don't log in.

{ "url": "https://app.example.com/reports/monthly", "format": "pdf", "waitForSelector": "[data-report-ready]", "cookies": [{ "name": "session", "value": "SESSION_VALUE", "domain": "app.example.com" }] }

Plan: Basic. waitForSelector waits up to 10 seconds for your charts to signal they are ready, then captures anyway. You build: combining several captures into one document, and delivery by email.

19. Certificates and badges

Render a certificate template with the recipient's details, then capture it as a high-resolution PNG.

{ "url": "https://example.com/certificates/render?id=CERT-1042&sig=SIGNATURE", "width": 1200, "height": 850, "deviceScaleFactor": 2, "format": "png" }

Plan: Free. Limit: there is no HTML-string input, so the template must live at a URL. Sign or expire those URLs so strangers can't generate certificates.

20. Records of what a user agreed to

Capture the terms, checkout or contract page a user accepted, at the time they accepted it.

{ "url": "https://app.example.com/contracts/CTR-8842", "fullPage": true, "format": "pdf", "cookies": [{ "name": "session", "value": "SESSION_VALUE", "domain": "app.example.com" }] }

Plan: Basic. "format": "html" (also Basic) saves the rendered markup as well. Limit: a screenshot is a record, not a tamper-proof one. Store a hash and timestamp alongside each file, and ask your legal team what evidence standard applies.

21. Terms of service history

Capture your own (or a vendor's) terms and privacy pages on a schedule so you can show what they said on a given date.

{ "url": "https://example.com/terms", "fullPage": true, "format": "png" }

Plan: Free (PDF on Basic). You build: the schedule and a store you can search by date.

22. Ad and landing page records

Keep evidence of how a promotion or landing page looked during a campaign.

{ "url": "https://partner-site.example/promo", "fullPage": true, "proxyRegion": "eu" }

Plan: Free without proxyRegion. Capturing through a regional proxy (us, eu or apac), so the site sees a visitor from that region, needs Scale. The geolocation option (Growth) only changes the browser's location API, not the visitor's IP address.

Record the cookie banner and consent flow visitors see, for privacy reviews.

{ "url": "https://example.com", "device": "desktop", "delay": 2000 }

Plan: Free. Leave blockAds and aiRemoval off here, because both are designed to hide cookie banners. Banners often depend on the visitor's region, so pair this with proxyRegion (Scale) if you need the EU version. Limit: the API captures the first screen. It cannot click through the "Manage preferences" steps.

24. Brand and trademark monitoring

Capture pages reported for misusing your brand, so your legal team has a dated copy.

{ "url": "https://flagged-site.example/page", "fullPage": true, "format": "png" }

Plan: Free. You build: finding the pages (search alerts, reports) and the case file.

Monitoring

25. Visual website monitoring

Capture key pages every hour or day and alert when they change more than expected.

{ "url": "https://example.com", "width": 1280, "height": 800, "waitForNetworkIdle": true }

Plan: Free. You build: the schedule, image comparison and alert thresholds. Dynamic content such as carousels, dates and ads creates noise, so hide those regions with hideSelectors (Growth) or compare only the parts that matter. See the website monitoring guide.

Quick reference

Use case Viewport Format Full page Useful options Minimum plan
Link preview 1200 × 630 JPEG/WebP No blockAds Free
Thumbnail 1280 × 720 WebP No quality Free
Documentation 1440 × 900 PNG Varies selector, cookies Basic (with cookies)
PDF report or invoice A4 (fixed) PDF n/a waitForSelector, headers Basic
Responsive check mobile 375 × 812 PNG Yes device Free
Archive 1920 × 1080 PNG Yes waitForNetworkIdle Free
Social card in a frame 1200 × 630 PNG No mockup Growth
Monitoring 1280 × 800 PNG No hideSelectors Free (Growth for hideSelectors)

How to choose where to start

  1. Name the trigger. A user action, a deploy, a schedule or a webhook from another system.
  2. Fix the output. Pick the viewport, format and full-page setting from the table above, and check the plan column.
  3. Decide where files live. Copy captures to your own storage for anything public or long-lived.
  4. Cache. Most previews and thumbnails can be reused for days. Basic plans can also send "cache": true with a cacheTtl of up to 24 hours.
  5. Handle failures. Some sites block automated browsers or time out. Show a placeholder and retry later, rather than failing the whole job.
  6. Watch usage. Every successful capture counts toward your plan. Failed ones don't.

For larger jobs, Basic plans can queue captures asynchronously with POST /api/jobs, and Growth plans can submit up to 20 at once. See async jobs.


Ready to try your use case?

Create a free API key →. It includes 100 captures to test with.

More implementation guides:

use-cases
examples
applications
business

About the Author

Asad Ali

Asad Ali

CTO at ZTABS and the developer behind Screenshotly. Writes about screenshot automation, API design, and building reliable SaaS backends with Next.js, Node.js, and TypeScript.

Credentials: CTO at ZTABS, full-stack developer, builder and maintainer of Screenshotly and its official JavaScript and Python clients

Frequently Asked Questions

What does a screenshot API actually do, and what doesn't it do?

It loads one URL in a server-side Chromium browser and returns the result as an image, PDF, HTML or short WebM video. It does not click through multi-step flows, solve CAPTCHAs, compare images, schedule jobs or host files permanently. You build those parts around it, or use tools such as Playwright for interaction and pixelmatch for diffs.

Which use cases work on the free plan?

Anything that needs a PNG, JPEG or WebP of a public page: link previews, thumbnails, directory listings, archives in image form, responsive layout checks and monitoring captures. The free plan includes 100 captures in total. PDF, signed-in pages, webhooks and retained download links need Basic; device mockups, AI element removal and custom JavaScript need Growth.

Can I capture pages that require a login?

Yes, on the Basic plan and above, by sending session cookies or request headers with the capture. The API cannot type a username and password or complete an OAuth or MFA flow for you, so you need a valid session from your own system first.

Ready to capture your first screenshot?

Get started with 100 free screenshots. No credit card required.

Related Articles