Authentication

All API requests require an API key. Rendex provides sub-millisecond edge verification across 300+ global locations.

Getting Your API Key

1. Sign in to your Rendex dashboard
2. Your first API key is auto-generated on signup
3. Create additional keys at Dashboard → API Keys

Using Your API Key

Include your API key in requests using either method:

Authorization Header (Recommended)

Authorization: Bearer rdx_your_api_key_here

X-API-Key Header

x-api-key: rdx_your_api_key_here

Query Parameter (GET Endpoint)

The GET /v1/screenshot endpoint also accepts the API key as a query parameter, enabling <img> tag embedding and browser access:

https://api.rendex.dev/v1/screenshot?url=https://example.com&key=rdx_your_api_key_here

Key Prefix

All Rendex API keys start with rdx_ for easy identification. This prefix is part of the key — include it in your requests.

Using Official SDKs

The official SDKs handle authentication automatically — just pass your API key when creating the client:

# JavaScript / TypeScript
npm install @copperline/rendex

# Python
pip install rendex

SDKs set the correct Authorization header on every request. No manual header management needed. See the Quick Start for full examples.

Key Security

• Show once: Full keys are only shown at creation. Store them securely.
• Environment variables: Never commit API keys to source code. Use RENDEX_API_KEY as your env var name.
• Revoke immediately: If a key is compromised, revoke it from the dashboard and create a new one.
• Multiple keys: Create separate keys for development, staging, and production.

Error Responses