Quick Start Guide

Get started with SnapshotAI in under 5 minutes. This guide will walk you through creating your first screenshot.

1. Create Your Account

👉

Create account at:

https://snapshotai.dev/auth/sign-up

2. Generate Your API Key

Once logged in, navigate to your dashboard to create an API key.

Navigate to:

Dashboard → API Keys → Create New Key

Important: Save your API key

Your API key will only be shown once. Store it securely - we cannot recover it if lost.

3. Capture Your First Screenshot

Use your API key to capture a screenshot. Here are examples in different languages:

cURL

Terminal

curl -X POST https://www.snapshotai.dev/api/v1/screenshots \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "options": {
      "viewport_width": 1920,
      "viewport_height": 1080,
      "format": "png"
    }
  }'

Node.js

JavaScript

const response = await fetch('https://www.snapshotai.dev/api/v1/screenshots', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    url: 'https://example.com',
    options: {
      viewport_width: 1920,
      viewport_height: 1080,
      format: 'png'
    }
  })
});

const data = await response.json();
console.log('Screenshot ID:', data.data.id);
console.log('Status:', data.data.status);

Python

import requests

response = requests.post(
    'https://www.snapshotai.dev/api/v1/screenshots',
    headers={
        'Authorization': 'Bearer sk_live_YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'url': 'https://example.com',
        'options': {
            'viewport_width': 1920,
            'viewport_height': 1080,
            'format': 'png'
        }
    }
)

data = response.json()
print(f"Screenshot ID: {data['data']['id']}")
print(f"Status: {data['data']['status']}"

4. Check Screenshot Status

Screenshots are processed asynchronously. Check the status using the screenshot ID:

Terminal

curl -X GET https://www.snapshotai.dev/api/v1/screenshots/SNAPSHOT_ID \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY"

Response Example:

{
  "success": true,
  "data": {
    "id": "abc123...",
    "status": "completed",
    "url_to_capture": "https://example.com",
    "download_url": "https://...",
    "created_at": "2024-01-27T10:30:00Z",
    "completed_at": "2024-01-27T10:30:45Z"
  }
}

5. Download Your Screenshot

Once the status is completed, use the download_url to get your image:

Terminal

# Download using the signed URL
curl "DOWNLOAD_URL" -o screenshot.png

# Or get via API endpoint
curl -X GET https://www.snapshotai.dev/api/v1/screenshots/SNAPSHOT_ID/download \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -o screenshot.png

Note: Download URLs are valid for 1 hour. After that, request a new one via the API.

⚡ Processing Times

⚡

Simple Pages

15-30s

📊

Complex Pages

30-60s

📄

Full Page

45-90s

🚀 Next Steps

Authentication →

Learn about API keys, security best practices, and key rotation

API Reference →

Explore all available options and advanced features

Guides →

Step-by-step tutorials for common use cases

Need Help?

Our support team is here to help you get started. We typically respond within a few hours.

Contact Support Join Community

3. Capture Your First Screenshot

Use your API key to capture a screenshot. Here are examples in different languages:

cURL

Terminal

curl -X POST https://www.snapshotai.dev/api/v1/screenshots \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "options": {
      "viewport_width": 1920,
      "viewport_height": 1080,
      "format": "png"
    }
  }'

Node.js

JavaScript

const response = await fetch('https://www.snapshotai.dev/api/v1/screenshots', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    url: 'https://example.com',
    options: {
      viewport_width: 1920,
      viewport_height: 1080,
      format: 'png'
    }
  })
});

const data = await response.json();
console.log('Screenshot ID:', data.data.id);
console.log('Status:', data.data.status);

Python

import requests

response = requests.post(
    'https://www.snapshotai.dev/api/v1/screenshots',
    headers={
        'Authorization': 'Bearer sk_live_YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'url': 'https://example.com',
        'options': {
            'viewport_width': 1920,
            'viewport_height': 1080,
            'format': 'png'
        }
    }
)

data = response.json()
print(f"Screenshot ID: {data['data']['id']}")
print(f"Status: {data['data']['status']}"

4. Check Screenshot Status

Screenshots are processed asynchronously. Check the status using the screenshot ID:

Terminal

curl -X GET https://www.snapshotai.dev/api/v1/screenshots/SNAPSHOT_ID \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY"

Response Example:

{
  "success": true,
  "data": {
    "id": "abc123...",
    "status": "completed",
    "url_to_capture": "https://example.com",
    "download_url": "https://...",
    "created_at": "2024-01-27T10:30:00Z",
    "completed_at": "2024-01-27T10:30:45Z"
  }
}

5. Download Your Screenshot

Once the status is completed, use the download_url to get your image:

Terminal

# Download using the signed URL
curl "DOWNLOAD_URL" -o screenshot.png

# Or get via API endpoint
curl -X GET https://www.snapshotai.dev/api/v1/screenshots/SNAPSHOT_ID/download \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -o screenshot.png

Note: Download URLs are valid for 1 hour. After that, request a new one via the API.