Skip to main content

Get Your API Key

Your API key is created automatically after you subscribe. Here's how to find and copy it.

Find your API key​

  1. Log in and go to your dashboard.
  2. Click API Keys in the sidebar.
  3. Your active keys are listed there.

Reveal and copy your key​

Keys are masked by default for security:

cai_****************************

To see the full key:

  1. Click the eye icon (👁) next to the key — the full key is revealed.
  2. Click the copy icon to copy it to your clipboard.
  3. Click the eye icon again to re-mask it.

:::warning Keep your key private Treat your API key like a password. Do not commit it to version control, share it publicly, or expose it in client-side browser code. :::

Using your key​

Once you have your key, add it to your project as an environment variable:

# .env or .env.local
CUSTODIAN_API_KEY=cai_your_key_here

Then use it in your code to authenticate requests. See Authentication for integration examples.

Key details​

Each key shows:

  • Plan — which subscription plan the key belongs to
  • Credits used — characters consumed so far
  • Credit limit — total characters available on your plan
  • Expiry — expiry date if applicable (blank means no expiry)

What if I don't see a key?​

  • Confirm your payment completed successfully on the Subscriptions page.
  • Wait a few seconds and refresh — key generation is automatic but may take a moment.
  • If the issue persists, see Troubleshooting.