API Key Management

Where to find your keys

Go to API Keys in the dashboard sidebar. All active keys on your account are listed here.

Key information displayed

Each key card shows:

Field	Description
Key	Masked by default; click 👁 to reveal
Plan	The subscription plan this key belongs to
Credits used	How many character credits have been consumed
Credit limit	Total credits available on your plan
Expires	Expiry date, if applicable
Created	When the key was generated

Reveal your key

Keys are hidden by default to prevent accidental exposure.

1. Click the eye icon (👁) to reveal the full key.
2. Click the copy icon to copy it to your clipboard.
3. Click the eye icon again to hide it.

How keys are created

API keys are created automatically after a successful subscription payment. You don't need to manually generate or request one.

If you don't see a key after subscribing:

• Wait a few seconds and refresh the page.
• Check the Subscriptions page to confirm payment was successful.
• See Troubleshooting if the issue persists.

Using your key in a project

Store your key as an environment variable — never hard-code it:

# .env or .env.local
CUSTODIAN_API_KEY=cai_your_key_here

Then reference it in your code:

const apiKey = process.env.CUSTODIAN_API_KEY;

Security best practices

• Never commit your API key to Git or any public repository.
• Never use it in client-side browser code — always keep it server-side.
• If you suspect your key has been exposed, contact support immediately to have it rotated.
• Use environment variable management tools (e.g., Vercel Environment Variables, AWS Secrets Manager) in production.

Key expiry

Some plans have time-limited keys. The Expires field on the key card shows the expiry date. After expiry, requests using that key will be rejected. Renew your subscription to receive a new key.