- Help Center
- How to Add Your AI API Key
How to Add Your AI API Key
Bring your own AI API key for unlimited AI suggestions and translations in Converge.
Get an API key from your AI provider
Converge requires an AI API key to power AI suggestions and translations. You add your own key in settings.
How to get an API key:
- Sign up or log in to your AI provider's dashboard
- Navigate to the API keys section
- Click "Create API key" or "New key"
- Copy the generated key
Security: API keys are sensitive credentials. Store them securely and never commit them to version control or share them publicly.
Cost: You pay your AI provider directly based on their usage pricing. AI usage depends on how many suggestions and translations your team generates.
Add the API key in Converge
In Converge, go to Settings → Replies → AI Settings. Only workspace Owners can configure AI settings.
Current AI settings: The AI settings page lets you enable or disable AI suggestions and choose a tone (professional, friendly, or casual). API key management is handled by your workspace administrator — contact your team lead if you need to update the key.
One key per workspace: Your API key is set at the workspace level. All AI features (suggestions, translations) will use this key.
Converge encrypts and stores your key securely using per-company encryption, and will use it for all subsequent AI requests.
Verify and test the connection
After saving your API key, verify it's working correctly.
Test AI suggestions: Open a conversation and look for AI suggestions in the message composer. If suggestions generate successfully, your key is working.
Test translation: If you have a multilingual conversation, test AI translation to verify the key works for translations too.
Common issues:
- "Invalid API key" error: Double-check you copied the entire key without extra spaces.
- "Quota exceeded" error: Your AI provider account has run out of credits or hit rate limits. Add credits to your provider account or wait for quota to reset.
- "Permission denied" error: Some API keys have restricted permissions. Make sure your key has access to the chat/completion API endpoints.
Manage and rotate your API key
Over time, you may need to update, rotate, or remove your API key.
When to rotate your key:
- Security best practice: Periodically rotate API keys (e.g., every 90 days) to limit exposure if a key is compromised
- After a security incident: If you suspect your key was leaked, rotate it immediately
- Changing providers: Switch from one AI provider to another
How to rotate:
- Generate a new API key from your AI provider
- In Converge, go to Settings → Replies → AI Settings
- Replace the old key with the new one
- Save and test the new key
- Revoke the old key from your AI provider's dashboard
Remove your key: If you want to stop using AI features, clear the API key field and save. AI suggestions and translations will be disabled until a key is added again.
Success indicator: When AI suggestions and translations work seamlessly in conversations — your API key setup is working correctly.