Authentication

API Keys

SnapshotAI uses API keys to authenticate requests. Your API keys carry many privileges, so be sure to keep them secure!

API Key Format

Making Authenticated Requests

Include your API key in the Authorization header with the Bearer scheme:

curl https://snapshotai.dev/api/v1/screenshots \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

export SNAPSHOTAI_API_KEY="sk_live_..."

Authentication Errors

{
  "success": false,
  "error": {
    "message": "Invalid API key",
    "code": "UNAUTHORIZED"
  }
}

{
  "success": false,
  "error": {
    "message": "API key is inactive",
    "code": "FORBIDDEN"
  }
}

Creating API Keys

Via Dashboard

1. Navigate to Dashboard → API Keys
2. Click Create New Key
3. Choose a name and type (Live or Test)
4. Optionally set an expiration date
5. Click Create and save the key immediately

Via API

curl -X POST https://snapshotai.dev/api/v1/keys \
  -H "Authorization: Bearer YOUR_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production API Key",
    "type": "live",
    "expires_at": "2025-12-31T23:59:59Z"
  }'

Key Rotation

If your API key is compromised, rotate it immediately:

curl -X POST https://snapshotai.dev/api/v1/keys/KEY_ID/rotate \
  -H "Authorization: Bearer YOUR_SESSION_TOKEN"

This will:

• Immediately invalidate the old key
• Generate a new key with the same permissions
• Return the new key (save it immediately!)

Security Best Practices

If Your API Key is Compromised