🔑 API Keys Guide
API Keys allow you to authenticate with the CLIA API from your own applications and services. This guide covers how to create, manage, and use your API Keys.
📋 Creating an API Key
To create a new API Key:
- Navigate to the Playground in your Dashboard.
- Go to the Settings or API Keys section.
- Click on "Generate New Key".
- Give your key a descriptive name (e.g., "Production Web App").
- ⚠️ IMPORTANT: Copy your key immediately. For security reasons, it will not be shown again.
🛠️ Managing Your Keys
In the API Keys management view, you can:
- View Active Keys: See a list of your existing keys and their prefixes.
- Track Usage: See how many requests have been made with each key.
- Revoke Keys: If a key is compromised or no longer needed, you can revoke it to disable access immediately.
🚀 Using the API Key
When making requests to the CLIA API, include your key in the
text
x-api-keyhttpGET /public/agents x-api-key: your_api_key_here
Security Best Practices
- Server-Side Only: Never expose your in client-side code (frontend, mobile apps).text
x-api-key - Rotation: Regularly rotate your keys to minimize the impact of a potential leak.
- Principle of Least Privilege: Create specific keys for specific agents when possible.