> ## Documentation Index
> Fetch the complete documentation index at: https://docs.joinyellowbrick.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Authentication

> Create a Premium API key and send it as a Bearer token.

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

<Steps>
  <Step title="Upgrade to Premium">
    Open [Premium](https://www.joinyellowbrick.com/premium) if you are not already a member.
  </Step>

  <Step title="Create the key">
    Open [Profile](https://www.joinyellowbrick.com/profile) and create an API key. Copy the secret immediately. Yellowbrick does not store it, and it is not shown again.
  </Step>

  <Step title="Send it on every request">
    Use the `Authorization` header:

    ```
    Authorization: Bearer yb_...
    ```
  </Step>
</Steps>

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.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.