Authentication

All PagePry API requests require an API key passed in the x-api-key header.

API key format

API keys use the prefix pp_live_ followed by a random string:

pp_live_a1b2c3d4e5f6...

Sending authenticated requests

Include your API key in the x-api-key header on every request:

curl -X POST https://api.pagepry.com/v1/scrape \
  -H "x-api-key: pp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

Managing API keys

API keys are created and managed in the PagePry dashboard:

1. Navigate to your organization
2. Go to Applications
3. Select an application or create a new one
4. Go to the API Keys tab

From there you can:

• Create new keys
• Rotate existing keys (generates a new key and invalidates the old one)
• Revoke keys that are no longer needed

Best practices

• Never commit API keys to source control. Use environment variables instead.
• Use separate keys per environment. Create different applications for development, staging, and production.
• Rotate keys regularly. If a key may have been exposed, rotate it immediately in the dashboard.
• Set up key expiration for temporary access or integrations.

Error responses

If your API key is missing or invalid, you'll receive a 401 response:

{
  "success": false,
  "error": "Invalid or missing API key"
}

See Errors for the full list of error codes.