API keys
Every request to the API is authenticated with an API key, passed in the X-API-Key
header. Keys are issued from the dashboard and always start
with the spy_ prefix.
Your API key is a secret. Keep it server-side, never commit it to source control, and
never expose it in client-side code. Anyone with your key can spend your credits.
Getting your key
- Sign up on the dashboard.
- Your API key is shown once at creation — copy it immediately.
- Only a hash of the key is stored on our side, so we can never show it to you again.
Rotating a key
You can regenerate your key from the dashboard at any time. Regenerating immediately
invalidates the previous key and returns a new one (shown once). Update your
integrations with the new key right away.
Missing or invalid key
A request without a valid key returns 401 Unauthorized:
See Errors for the full list of status codes.