PageVistly API

Screenshots, PDFs, and OG images — rendered in real Chrome, returned as agent-friendly content.

Base URL: https://api.pagevistly.com

Quick start

Grab an API key from the dashboard (Google sign-in), then call any endpoint.

# Screenshot a URL
curl -X POST https://api.pagevistly.com/v1/screenshot \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://stripe.com/pricing","full_page":true}' \
  --output page.png

# Agent mode — compact preview + text + signed URL
curl -X POST https://api.pagevistly.com/v1/screenshot \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://stripe.com/pricing","response":"agent","detail":"low"}'

const res = await fetch("https://api.pagevistly.com/v1/screenshot", {
  method: "POST",
  headers: {
    "Authorization": "Bearer sk_live_xxx",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ url: "https://example.com", response: "agent" }),
});
const data = await res.json();

Authentication

All /v1/* endpoints require an API key. Pass it as a Bearer token, or the api_key query/body parameter.

Authorization: Bearer sk_live_xxx
# or
?api_key=sk_live_xxx

Keys are created in the dashboard. Each key has its own rate limit and monthly quota tied to your plan.

Screenshot POST /v1/screenshot

Capture a webpage as PNG/JPEG/WebP. Add response: "agent" to get context-friendly JSON instead of binary image data. Supports GET with query params too.

Parameters

Agent mode

When response: "agent", the API returns JSON instead of binary. This is the core of PageVistly — output designed for agent context, not human eyeballs.

{
  "ok": true,
  "title": "Stripe Pricing",
  "text": "Pricing. Starter $9...",
  "links": [{ "href": "...", "text": "..." }],
  "preview": "iVBOR...",
  "est_tokens": 1800,
  "full_res_url": "https://api.pagevistly.com/v1/file?key=..."
}

Visual diff

Add diff: true to detect what changed since the last render of the same URL — ideal for monitoring agents.

{
  "changed": true,
  "diff": {
    "added": ["Pro $39/mo"],
    "removed": ["Pro $29/mo"]
  }
}

The first call with diff: true establishes a baseline (no changed field). Subsequent calls compare against it. Baseline text is stored in R2 keyed by URL.

Visual description

Add visual: true to describe the screenshot with a vision model — useful for charts, tables, or Canvas content that DOM text extraction can't capture.

{
  "visual_description": "A pricing page with three tiers: Free, Starter ($5/mo), Pro ($15/mo)..."
}

PDF POST /v1/pdf

Convert a URL or raw HTML to a print-perfect PDF.

curl -X POST https://api.pagevistly.com/v1/pdf \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","format":"A4"}' \
  --output page.pdf

OG image POST /v1/og-image

Generate a 1200×630 social card from a template.

Fetch full-res GET /v1/file

Retrieve the full-resolution original behind a full_res_url from agent mode.

curl "https://api.pagevistly.com/v1/file?key=screenshot/<hash>.png" \
  -H "Authorization: Bearer sk_live_xxx" --output full.png

MCP server

Drop PageVistly straight into Claude Desktop, Cursor, or any MCP client. Two tools: read_page and make_og_image.

{
  "mcpServers": {
    "pagevistly": {
      "command": "npx",
      "args": ["-y", "@pagevistly/mcp"],
      "env": { "PAGEVISTLY_API_KEY": "sk_live_xxx" }
    }
  }
}

Caching

PageVistly uses a three-tier cache: edge Cache API → R2 persistent cache → live render.

Enable caching with cache_ttl (seconds). Cached responses don't count against your quota.

Error codes

Errors are deterministic JSON — agents can parse them reliably. Format: {"error": "<code>"}.

Rate limits & quota

Rate limit: 60 requests/minute per key. Monthly quota by plan:

Usage resets on the 1st of each month (UTC). Track usage in the dashboard.