Capture screenshots

Capture a page

curl --fail-with-body https://api.pagepith.com/v1/api/screenshot \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com"}' \
  --output screenshot.jpg

A successful response contains the image bytes with Content-Type: image/jpeg. The X-Final-Url response header identifies the URL after redirects.

This endpoint returns a JPEG, not JSON. Save the response as an image or read it as a binary buffer.

Use JavaScript

import { writeFile } from "node:fs/promises";

const response = await fetch("https://api.pagepith.com/v1/api/screenshot", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.PAGEPITH_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ url: "https://example.com" }),
});

if (!response.ok) {
  throw new Error(`Screenshot failed (${response.status}): ${await response.text()}`);
}

await writeFile("screenshot.jpg", Buffer.from(await response.arrayBuffer()));

Credits and limits

Each successful capture costs 5 credits. Failed captures are not charged. Starter and free accounts need at least 5 available credits before a capture starts. Pro and Business plans can use their configured metered overage.

The endpoint captures the visible viewport at 1280 × 800 pixels. It does not currently support full-page capture, custom viewport sizes, or other image formats. Only public HTTP and HTTPS URLs are accepted.

Errors

Status	Meaning
400	The URL is invalid or points to a private network.
401	The API key is missing or invalid.
402	There are not enough credits to capture the page.
422	The target page returned an error or no screenshot was available.
502	The browser could not capture the page.

Error responses contain JSON. See the screenshot API reference for the request and response details.

Getting started

Guides

API reference

Capture screenshots

Capture a page

Use JavaScript

Credits and limits

Errors

​Capture a page

​Use JavaScript

​Credits and limits

​Errors

Capture a page

Use JavaScript

Credits and limits

Errors