Skip to main content

​
Quickstart Guide

Follow this guide to start capturing screenshots with Screenshotly.

​
Step 1: Get Your API Token

  1. Sign up for a Screenshotly account
  2. Go to the API Tokens page
  3. Click “Generate New Token”
  4. Copy your API token (you won’t be able to see it again)

​
Step 2: Make Your First API Call

Using your API token, you can now make requests to the Screenshotly API. 
curl -X POST https://api.screenshotly.app/screenshot \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "device": "desktop",
    "format": "png"
  }'

​
Step 3: Customize Your Screenshot

Screenshotly offers many options to customize your screenshots: 
{
  "url": "https://example.com",
  "device": "desktop",
  "format": "png",
  "fullPage": true,
  "hideElements": {
    "cookieBanners": true,
    "ads": true,
    "popups": true
  },
  "delay": 1000
}

​
Step 4: Apply a Mockup

You can enhance your screenshots by applying device mockups: 
# First, capture a screenshot
curl -X POST https://api.screenshotly.app/screenshot \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "device": "desktop"
  }' \
  -o screenshot.png

# Then, apply a mockup
curl -X POST https://api.screenshotly.app/mockups \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "[email protected]" \
  -F "templateId=browser-mockup"

​
Next Steps