Authentication

​

Getting your API key

1. Sign in to your dashboard
2. Navigate to API settings
3. Copy your API key

​

Using your API key

​

Header authentication (recommended)

curl -X POST https://api.screenshotly.dev/v1/capture \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

import { Screenshotly } from 'screenshotly-js';

const client = new Screenshotly('YOUR_API_KEY');

import requests

headers = {
    'X-API-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
}

​

Query parameter authentication

curl "https://api.screenshotly.dev/v1/capture?api_key=YOUR_API_KEY&url=https://example.com"

​

Environment variables

export SCREENSHOTLY_API_KEY="your-api-key-here"

const client = new Screenshotly(process.env.SCREENSHOTLY_API_KEY);

import os
API_KEY = os.environ['SCREENSHOTLY_API_KEY']

​

Authentication errors

{
  "error": {
    "code": "missing_api_key",
    "message": "API key is required. Pass it via X-API-Key header or api_key query parameter."
  }
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "The provided API key is invalid or has been revoked."
  }
}

​

Security best practices

• Never expose keys in client-side code — only use API keys in server-side applications
• Don’t commit keys to version control — use .env files and add them to .gitignore
• Use separate keys for environments — generate different keys for development, staging, and production
• Rotate keys regularly — revoke old keys and generate new ones from the dashboard
• Revoke compromised keys immediately — if a key is exposed, revoke it in API settings