API Documentation

From zero to your first screenshot in under a minute. One endpoint, three steps.

ScreenshotAPI authenticates requests via API keys. Pass your key as a Bearer token or as the access_key query parameter.

/api/v1/screenshot

Capture any public URL as a PNG, JPEG, or WebP image. The simplest possible request.

/api/v1/screenshot

Render any URL as a PDF document. Set format=pdf and optionally choose paper size and orientation.

/api/v1/screenshot

Render a raw HTML string as an image. No public URL needed. Useful for generating OG images, cards, and reports.

/api/v1/screenshot

Record a page as an MP4, WebM, or animated GIF. Set format to a video type and optionally control duration and FPS.

/api/v1/screenshot

One endpoint handles everything: screenshots, PDFs, videos, and GIFs. Accepts GET and POST.

Capture from a live URL, raw HTML string, or Markdown, controlled by the source parameter.

Set viewport size, device pixel ratio, or use a device preset to emulate any screen: iPhone, iPad, 4K desktop, and more.

Wait for network idle, a specific element, or a fixed delay before the capture fires.

Capture the entire scrollable page height, not just the visible viewport.

Block ads, trackers, cookie banners, chat widgets, or any custom URL pattern. Resources are never loaded.

Click, hover, scroll, hide, or capture a single element using CSS selectors before the screenshot is taken.

Inject custom CSS or JavaScript into the page before the screenshot is taken.

Emulate dark mode, reduced motion, print media, timezone, and geographic location.

Pass custom cookies, headers, and a user-agent to the browser when it loads the target page.

/api/v1/screenshot

All supported output formats: PNG, JPEG, WebP, PDF, MP4, MOV, AVI, WebM, and GIF. Choose with the format parameter.

/api/v1/screenshot

Render any URL or HTML as a PDF with full control over paper size, orientation, margins, and print-media CSS.

/api/v1/screenshot

Record a video or animated GIF of a page. Supported formats: mp4, mov, avi, webm, gif.

Choose how the result is delivered: raw binary, Base64 string, JSON with a hosted URL, or just the URL as plain text.

Resize the output image after capture, or produce a transparent background. Useful for generating thumbnails.

Extract page title, Open Graph tags, favicon, HTTP status, image dimensions, fonts, or full page content alongside the screenshot.

/api/v1/screenshot

Queue a capture job and receive the result via webhook. Ideal for long-running captures or high-volume workloads.

Generate tamper-proof signed URLs so the capture endpoint can be called from the browser without exposing your API key.

Cache results to avoid re-capturing the same URL and reduce quota usage.

Every error response uses a consistent JSON shape with an error code and a human-readable message.

Two independent limits apply: a per-minute request cap and a monthly screenshot quota. Both vary by plan.

ScreenshotAPI offers four plans: Free, Starter, Growth, and Scale, each with different monthly quotas, video limits, and per-minute rate limits.

HTTP headers returned with every API response.

/api/v1/usage

Query your capture logs and usage statistics programmatically.

Ready-to-run recipes for the most common screenshot automation scenarios.