Snapshot API

API Documentation

Build screenshot, visual comparison, and webpage analysis workflows with a single API. Capture simple screenshots with v1, control rendering with v2, compare two states with v3 compare, or extract structured AI insights with v3 analyze.

Base URL: https://api.prod.ss.snapshot-site.com
Header: x-snapshotsiteapi-key
Quick Start
1

Create or copy your API key from Snapshot Site.

2

Send a JSON POST request to the endpoint that matches your use case.

3

Pick the language tab you need and adapt the sample payload.

4

Store the returned screenshot, diff, or analysis payload in your product.

5

Reach for the official SDKs or the hosted Snapshot Site MCP when you want assistant-first integration instead of raw HTTP.

Implementation Notes
1All requests use JSON over HTTPS.
2Use delay, hide, and javascriptCode for dynamic pages.
3Compare v3 returns before, after, and diff image URLs with mismatch metrics.
4Analyze v3 returns both capture data and AI-generated page insights.
Official SDKs & MCP
@snapshot-site/sdk

TypeScript SDK

Use the official TypeScript client for screenshot, analyze, and compare workflows in Node.js services, scripts, and full-stack apps.

pnpm add @snapshot-site/sdk
snapshot-site-sdk

Python SDK

Use the official Python client for content QA, batch capture jobs, AI analysis pipelines, and local asset downloads.

pip install snapshot-site-sdk
snapshot-site/php-sdk

PHP SDK

Use the official PHP client for Laravel, Symfony, WordPress, and custom backend screenshot workflows.

composer require snapshot-site/php-sdk
@snapshot-site/mcp

Snapshot Site MCP

Use the hosted MCP server with ChatGPT, Claude, and other MCP clients, or run the local package in stdio mode with an API key.

npx @snapshot-site/mcp
@snapshot-site/cli

Snapshot Site CLI

Use the official CLI for shell workflows, CI jobs, quick comparisons, and saving returned assets locally.

pnpm add -g @snapshot-site/cli
Workflow Guides

Visual Diff API

See the compare endpoint, sample payload, and release-review use cases.

Snapshot Site Console

Manage API keys, usage, billing, and test requests in the browser.

Endpoint 1

Capture a Screenshot (v1)

Use v1 for fast website capture with a minimal JSON body.

Method
POST
Audience
Basic capture
POSTBasic capture
https://api.prod.ss.snapshot-site.com/api/v1/screenshot

Capture a webpage screenshot with width, height, format and basic rendering options.

Path
/api/v1/screenshot
Schema Fields
7 fields

Request Body Schema

Field reference for this endpoint.

urlRequired
Type
string (uri)
Description

Target webpage URL to capture.

formatOptional
Type
string (png | jpeg | jpg | webp | pdf)
Description

Output format. Default: png.

widthOptional
Type
integer (100-8000)
Description

Viewport width in pixels. Default: 1280.

heightOptional
Type
integer or null (100-20000)
Description

Viewport height in pixels. Default: 720.

delayOptional
Type
integer (0-10)
Description

Delay in seconds before capture. Default: 0.

fullSizeOptional
Type
boolean
Description

Capture the full page instead of the viewport only.

hideCookieOptional
Type
boolean
Description

Hide common cookie banners before capture.

Example Response

Typical payload returned by the API.

JSON
{
  "status": "success",
  "fetchTime": "2026-03-26T18:42:34.138Z",
  "message": "Screenshot successfully created!",
  "url": "https://wikipedia.org",
  "width": 1280,
  "height": 720,
  "link": "https://api-prod-eks.snapshot-site.com/screenshots/wikipedia.org/0a7b2bb1-a139-4bf1-80f3-ea41dae662e4/1774550554138.png"
}

Code Examples

Switch language and copy the request snippet.

cURLPOST
curl --request POST \
  --url https://api.prod.ss.snapshot-site.com/api/v1/screenshot \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-snapshotsiteapi-key: YOUR_API_KEY' \
  --data '{"url":"https://wikipedia.org","format":"png","width":1280,"height":720,"delay":0,"fullSize":false,"hideCookie":false}'

Subscribe to Snapshot Site API

Snapshot Site is a powerful API that allows you to capture full-page, high-resolution screenshots of any website with pixel-perfect accuracy.
Simply send a URL to the API to generate a complete snapshot — not just the visible area — covering entire web pages, scrolling content, landing pages, blogs, news articles, social media posts, videos, and more.
Designed for developers, designers, marketers, and journalists,
Snapshot Site makes it easy to integrate web page capture into your applications, workflows, and automation tools.

Subscribe Now
bg wave