Skip to main content
API keys are Premium-only. Free accounts see an upgrade prompt on Profile and cannot create a key. You can have one key. The key identifies the Yellowbrick account. That account must have an active Premium membership on every /api/v1 request.

​
Create a key

1

Upgrade to Premium

Open Premium if you are not already a member.
2

Create the key

Open Profile and create an API key. Copy the secret immediately. Yellowbrick does not store it, and it is not shown again.
3

Send it on every request

Use the Authorization header:
On Staging, you can send Vercel’s optional x-vercel-protection-bypass query parameter (Deployment Protection → Protection Bypass for Automation). Production ignores it. Rotate the key from Profile when you need a new secret. The old secret stops working immediately. Delete the key to revoke access. If Premium lapses, the key still exists but every /api/v1 request returns 403 until you resubscribe.