Docs
Creating Keys
Creating Keys
Learn how to create and configure virtual keys for API access.
Create virtual keys to manage API access, set rate limits, and track usage per application or team.
Creating a Developer API Key
From Settings
- Go to Settings > API Keys
- Click Create API Key
- Enter a descriptive name
- Configure optional settings
- Click Create
- Copy the key immediately (shown only once)
Key Configuration Options
| Option | Description |
|---|---|
| Name | Descriptive identifier |
| Expiration | Optional expiry date |
| Rate Limit | Requests per minute |
| Budget | Optional spending cap |
Key Naming Conventions
Use descriptive names that identify:
- Purpose:
production-chat,dev-testing - Application:
web-app-frontend,mobile-api - Environment:
staging-backend,prod-analytics - Team:
engineering-team,support-bot
Configuration Examples
Development Key
Name: development-local
Rate Limit: 20 requests/minute
Budget: $10/month
Expiration: None
Production Key
Name: production-web-app
Rate Limit: 200 requests/minute
Budget: $500/month
Expiration: None
Limited Testing Key
Name: qa-testing-ephemeral
Rate Limit: 10 requests/minute
Budget: $5/month
Expiration: 30 days
After Creation
Once created, you'll see:
- API Key:
elyxir_xxxxx...(copy immediately) - Key ID: Internal identifier for management
- Configuration Summary: Your settings
The full API key is only shown once. Store it securely immediately after creation.
Managing Keys
Viewing Keys
Go to Settings > API Keys to see all keys:
- Key name and partial key ID
- Creation date
- Last used date
- Status (active/inactive)
Editing Keys
Most settings can be edited after creation:
- Click on a key in the list
- Modify settings (name, limits, budget)
- Save changes
The API key value itself cannot be changed. To get a new key value, create a new key.
Revoking Keys
To permanently disable a key:
- Find the key in Settings > API Keys
- Click the menu icon
- Select Revoke
- Confirm revocation
Revoked keys cannot be reactivated. Any applications using the key will immediately fail authentication.
Programmatic Key Management
Use the API to manage keys programmatically:
# Example: List keys (future API)
# Note: Key management API may require admin permissionsSecurity Recommendations
Do
- Create separate keys per environment
- Set expiration for temporary keys
- Use budget limits to control costs
- Monitor key usage regularly
- Revoke compromised keys immediately
Don't
- Share keys between applications
- Use production keys for development
- Create keys without meaningful names
- Leave unused keys active
Related
- Virtual Keys Overview - Key concepts
- Rate Limits - Limit configuration
- API Authentication - Using keys