API Documentation

curl "https://app.snap-render.com/v1/screenshot?url=https://example.com&format=png" \
  -H "X-API-Key: YOUR_API_KEY" \
  --output screenshot.png

X-API-Key: sk_live_your_key_here

https://app.snap-render.com

{
  "url": "https://example.com",
  "format": "png",
  "width": 1280,
  "height": 800,
  "image": "data:image/png;base64,iVBORw0KGgo...",
  "size": 248576,
  "cache": "MISS",
  "responseTime": "2847ms",
  "remainingCredits": 8577
}

{
  "error": {
    "code": "INVALID_URL",
    "message": "The provided URL is not a valid HTTP/HTTPS URL.",
    "status": 400
  }
}

import SnapRender from 'snaprender';
import fs from 'node:fs';

const snap = new SnapRender({ apiKey: 'sk_live_your_key_here' });

// Capture as buffer
const buffer = await snap.capture({ url: 'https://example.com', format: 'png' });
fs.writeFileSync('screenshot.png', buffer);

// Capture with options
const result = await snap.capture({
  url: 'https://github.com',
  format: 'jpeg',
  fullPage: true,
  darkMode: true,
  quality: 85,
  device: 'iphone_15_pro',
});
fs.writeFileSync('github-mobile-dark.jpg', result);

// Check usage
const usage = await snap.usage();
console.log(`${usage.remaining} screenshots remaining`);

from snaprender import SnapRender

snap = SnapRender("sk_live_your_key_here")

# Capture as bytes
data = snap.capture("https://example.com", format="png")
with open("screenshot.png", "wb") as f:
    f.write(data)

# Capture with options
data = snap.capture(
    "https://github.com",
    format="jpeg",
    full_page=True,
    dark_mode=True,
    quality=85,
    device="iphone_15_pro",
)
with open("github-mobile-dark.jpg", "wb") as f:
    f.write(data)

# Check usage
usage = snap.usage()
print(f"{usage['remaining']} screenshots remaining")

package main

import (
    "context"
    "log"
    "os"

    snaprender "github.com/User0856/snaprender-go"
)

func main() {
    client := snaprender.NewClient("sk_live_your_key_here")

    // Capture a screenshot
    img, err := client.Capture(context.Background(), "https://example.com", nil)
    if err != nil {
        log.Fatal(err)
    }
    os.WriteFile("screenshot.png", img, 0644)

    // With options
    img, _ = client.Capture(context.Background(), "https://github.com", &snaprender.CaptureOptions{
        Format:   "jpeg",
        DarkMode: snaprender.Bool(true),
        Device:   "iphone_15_pro",
    })

    // Generate signed URL
    signed, _ := client.Sign(context.Background(), "https://example.com", &snaprender.SignOptions{
        ExpiresIn: 86400,
    })
    log.Println(signed.SignedURL)
}

use SnapRender\SnapRender;

$snap = new SnapRender('sk_live_your_key_here');

// Capture a screenshot
$image = $snap->capture('https://example.com');
file_put_contents('screenshot.png', $image);

// With options
$image = $snap->capture('https://github.com', [
    'format' => 'jpeg',
    'dark_mode' => true,
    'device' => 'iphone_15_pro',
]);

// Generate signed URL
$signed = $snap->sign('https://example.com', ['expires_in' => 86400]);
echo $signed['signed_url'];

require "snaprender"

snap = SnapRender.new("sk_live_your_key_here")

# Capture a screenshot
image = snap.capture("https://example.com")
File.binwrite("screenshot.png", image)

# With options
image = snap.capture("https://github.com",
  format: "jpeg",
  dark_mode: true,
  device: "iphone_15_pro"
)

# Generate signed URL
signed = snap.sign("https://example.com", expires_in: 86400)
puts signed["signed_url"]

{
  "mcpServers": {
    "snaprender": {
      "type": "streamable-http",
      "url": "https://app.snap-render.com/mcp",
      "headers": {
        "Authorization": "Bearer sk_live_your_key_here"
      }
    }
  }
}

{
  "mcpServers": {
    "snaprender": {
      "command": "npx",
      "args": ["-y", "snaprender-mcp"],
      "env": {
        "SNAPRENDER_API_KEY": "sk_live_your_key_here"
      }
    }
  }
}

curl "https://app.snap-render.com/v1/screenshot?url=https://example.com&format=png" \
  -H "X-API-Key: YOUR_API_KEY" \
  --output screenshot.png

curl "https://app.snap-render.com/v1/screenshot?url=https://en.wikipedia.org/wiki/Screenshot&format=png&full_page=true" \
  -H "X-API-Key: YOUR_API_KEY" \
  --output full-page.png

curl "https://app.snap-render.com/v1/screenshot?url=https://github.com&format=png&dark_mode=true" \
  -H "X-API-Key: YOUR_API_KEY" \
  --output github-dark.png

curl "https://app.snap-render.com/v1/screenshot?url=https://example.com&device=iphone_15_pro&format=png" \
  -H "X-API-Key: YOUR_API_KEY" \
  --output mobile.png

curl "https://app.snap-render.com/v1/screenshot?url=https://example.com&format=png&hide_selectors=.header,.footer,%23sidebar" \
  -H "X-API-Key: YOUR_API_KEY" \
  --output clean.png

curl "https://app.snap-render.com/v1/screenshot?url=https://example.com&format=pdf&full_page=true" \
  -H "X-API-Key: YOUR_API_KEY" \
  --output page.pdf

curl "https://app.snap-render.com/v1/screenshot?url=https://example.com&format=png&response_type=json" \
  -H "X-API-Key: YOUR_API_KEY"

curl -X POST "https://app.snap-render.com/v1/screenshot" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"html":"<html><body><h1>Hello World</h1></body></html>","format":"png","width":800,"height":600}' \
  --output screenshot.png

curl -X POST "https://app.snap-render.com/v1/screenshot" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"markdown":"# Hello World\n\nThis is **bold** and this is `code`.","format":"png"}' \
  --output screenshot.png

curl -X POST "https://app.snap-render.com/v1/screenshot/sign" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","expires_in":86400}'

# No API key needed, just use the signed_url from the sign response
curl "https://app.snap-render.com/v1/screenshot/render?url=...&expires=...&key_prefix=...&sig=..." \
  --output screenshot.png

curl "https://app.snap-render.com/v1/extract?url=https://example.com&type=markdown" \
  -H "X-API-Key: YOUR_API_KEY"

curl -X POST "https://app.snap-render.com/v1/extract" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","type":"article"}'

curl "https://app.snap-render.com/v1/extract?url=https://example.com&type=metadata" \
  -H "X-API-Key: YOUR_API_KEY"

curl -X POST "https://app.snap-render.com/v1/screenshot/batch" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": ["https://example.com", "https://github.com", "https://google.com"],
    "format": "png",
    "width": 1280,
    "dark_mode": true
  }'

curl "https://app.snap-render.com/v1/screenshot/batch/JOB_ID" \
  -H "X-API-Key: YOUR_API_KEY"

curl -X POST "https://app.snap-render.com/v1/webhooks" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhook",
    "events": ["screenshot.completed", "quota.warning"]
  }'

import { createHmac } from 'crypto';

function verifySignature(payload, signature, secret) {
  const expected = createHmac('sha256', secret).update(payload).digest('hex');
  const sig = signature.replace('sha256=', '');
  return sig === expected;
}

// In your webhook handler:
const isValid = verifySignature(
  req.body,                                    // raw body string
  req.headers['x-snaprender-signature'],       // sha256=...
  'whsec_your_webhook_secret'
);

const url = new URL('https://app.snap-render.com/v1/screenshot');
url.searchParams.set('url', 'https://example.com');
url.searchParams.set('format', 'png');
url.searchParams.set('dark_mode', 'true');

const res = await fetch(url, {
  headers: { 'X-API-Key': 'YOUR_API_KEY' },
});

const buffer = Buffer.from(await res.arrayBuffer());
fs.writeFileSync('screenshot.png', buffer);
console.log(`Cache: ${res.headers.get('x-cache')}, Remaining: ${res.headers.get('x-remaining-credits')}`);

import requests

response = requests.get(
    "https://app.snap-render.com/v1/screenshot",
    params={"url": "https://example.com", "format": "png", "dark_mode": "true"},
    headers={"X-API-Key": "YOUR_API_KEY"},
)
response.raise_for_status()

with open("screenshot.png", "wb") as f:
    f.write(response.content)
print(f"Cache: {response.headers['X-Cache']}, Remaining: {response.headers['X-Remaining-Credits']}")

curl "https://app.snap-render.com/v1/usage" \
  -H "X-API-Key: YOUR_API_KEY"