Authentication

All API requests require an API key.

Getting Your API Key

1. Sign in at app.urlpix.com
2. Go to API Keys
3. Click Create New Key
4. Copy and store your key securely

API keys follow the format sk_live_ followed by 32 random characters.

Using Your API Key

Header (Recommended)

curl "https://api.urlpix.com/v1/screenshot?url=https://example.com" \
  -H "X-API-Key: sk_live_YOUR_KEY"

Query Parameter

curl "https://api.urlpix.com/v1/screenshot?url=https://example.com&api_key=sk_live_YOUR_KEY"

The header method is preferred as it keeps your key out of server logs and browser history.

JavaScript Example

const response = await fetch(
  'https://api.urlpix.com/v1/screenshot?url=https://example.com',
  { headers: { 'X-API-Key': 'sk_live_YOUR_KEY' } }
)
const blob = await response.blob()

Key Management

• You can create multiple API keys per account (plan limits apply)
• Keys can be revoked instantly from the dashboard
• Revoked keys return 401 Invalid or revoked API key.

Error Responses

Status	Message
401	Missing API key. Provide X-API-Key header or api_key query parameter.
401	Invalid API key format.
401	Invalid or revoked API key.