API keys

​

Generating a new key

1. Go to API settings
2. Click Generate new API key
3. Give the key a descriptive name (e.g., “Production server”, “Staging”)
4. Copy the key immediately

​

Using your key

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"}'

curl "https://api.screenshotly.dev/v1/capture?url=https://example.com&api_key=YOUR_API_KEY" \
  --output screenshot.png

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

​

Revoking a key

1. Go to API settings
2. Find the key you want to revoke
3. Click Revoke
4. Confirm the action

​

Best practices

• Use environment variables — never hardcode API keys in source files
• Separate keys per environment — use different keys for development, staging, and production
• Name keys descriptively — so you know which key is used where
• Revoke unused keys — remove keys that are no longer in use
• Rotate keys periodically — generate new keys and phase out old ones
• Never commit keys — add .env to your .gitignore file

# .env
SCREENSHOTLY_API_KEY=your-api-key-here

# .gitignore
.env