Pageshot
Launchpad

Authentication

How to authorize requests with API keys.

Pageshot authenticates API consumers using an access key.

Send the key in a header

curl -H "X-Access-Key: your_api_key" \
  https://api.pageshot.com/v1/health
const response = await fetch('https://api.pageshot.com/v1/health', {
  headers: {
    'X-Access-Key': process.env.PAGESHOT_KEY
  }
});
import os
import requests

response = requests.get(
    'https://api.pageshot.com/v1/health',
    headers={'X-Access-Key': os.environ['PAGESHOT_KEY']}
)

Or use a query parameter

curl "https://api.pageshot.com/v1/capture?access_key=your_api_key"

Prefer headers

Use the header whenever possible to avoid leaking keys in logs, caches, or analytics.