Skip to main content

API Key Format

Every tenant receives a key in the format:
  • ack_live_ — prefix identifies it as an Aether Citadel key
  • Followed by 48 hex characters (24 random bytes) — cryptographically secure

How to Use Your Key

Pass the key in the X-Citadel-Key header on every request:
Never put your API key in URLs, query parameters, or client-side JavaScript. It belongs in a server-side environment variable only.

Security Model


Rotate a Compromised Key

If your key is exposed, generate a new one immediately. The old key is invalidated the moment you rotate.
Update all your services before rotating. Once rotated, the old key returns 401 on every request.

Plan Limits

When you exceed your limit, requests return 429 Too Many Requests. Upgrade your plan to restore access.

Admin vs Tenant Keys

Both key types use the same header. The server validates them through the same constant-time comparison.