AI Providers Module Documentation
Table of Contents
- Module Overview (Technical)
- Module Overview (Commercial/Business)
- Module Overview (End User/Administrator)
- Configuration Sections
- Settings Reference
- Common Scenarios & Examples
- Limitations & Important Notes
- Troubleshooting Tips
- Glossary
---
1. Module Overview (Technical)
What Are AI Providers?
AI Providers is a credential management module that stores API keys and configuration for AI services. These providers enable AI-powered features like TTS (Text-to-Speech), STT (Speech-to-Text), transcription, and intelligent assistants.
Architecture
Key Tables
| Table | Purpose |
|---|---|
public.ai_providers | Provider credentials |
Key Files
| File | Description |
|---|---|
modules/aiProviders/ | Frontend module |
2. Module Overview (Commercial/Business)
Business Value
AI Providers provides centralized AI credential management:
| Without Module | With Module | |
|---|---|---|
| Hardcoded keys | Web interface | |
| Single provider | Multiple providers | |
| No failover | Provider selection | |
| No testing | Connection testing |
Use Cases
- Voice Generation
- Custom voice cloning
- Transcription
- Voicemail to text
- Analysis
- Call summarization
- Assistants
- Interactive IVR
Feature Highlights
| Feature | Benefit | |
|---|---|---|
| Multiple Providers | OpenAI, ElevenLabs, etc. | |
| API Key Storage | Secure credential vault | |
| Custom URLs | Self-hosted models | |
| Connection Test | Verify credentials | |
| Enable/Disable | Toggle providers | |
| Organization ID | Enterprise accounts |
3. Module Overview (End User/Administrator)
What Can You Do?
- Add AI provider credentials
- Store API keys securely
- Configure custom endpoints
- Test connections
- Enable/disable providers
- Refresh capabilities
- Manage organization IDs
AI Providers - List View
Add/Edit AI Provider
Quick Tips
TIP
Test First: Always test connection after adding API key.TIP
Custom URL: Use Base URL for self-hosted or proxy endpoints.WARNING
Keep Keys Secret: API keys are sensitive credentials.---
4. Configuration Sections
Provider Configuration
| Field | Description | |
|---|---|---|
| Provider | AI service type | |
| Name | Friendly identifier |
API Settings
| Field | Description | |
|---|---|---|
| API Key | Secret authentication key | |
| Base URL | Custom endpoint (optional) |
Organization Settings
| Field | Description |
|---|---|
| Organization | OpenAI org ID (optional) |
Status & Management
| Field | Description | |
|---|---|---|
| Enabled | Active/Inactive | |
| Created At | Creation timestamp | |
| Updated At | Last modification |
5. Settings Reference
Supported Providers
| Provider | Services | Use Cases | |
|---|---|---|---|
| OpenAI | GPT-4, TTS, Whisper | LLM, Voice, Transcription | |
| ElevenLabs | Voice clone, TTS | Natural voice generation | |
| Anthropic | Claude | Text analysis, summaries | |
| Cloud TTS, Vertex AI | Enterprise TTS, ML | ||
| Azure OpenAI | OpenAI on Azure | Enterprise OpenAI |
Provider-Specific Settings
| Provider | Extra Fields | |
|---|---|---|
| OpenAI | Organization ID | |
| Azure | Key Type (universal) | |
| Key Type selection |
API Key Formats
| Provider | Format Example | |
|---|---|---|
| OpenAI | sk-xxxxxxxxxxxxxxxx | |
| ElevenLabs | xxxxxxxxxxxxxxxxxxxxxxx | |
| Anthropic | sk-ant-xxxxxxxxxxxxxxxx | |
| AIzaXXXXXXXXXXXXXXXXXXXXX | ||
| Azure | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
Actions
| Action | Description | |
|---|---|---|
| Test Connection | Verify API key works | |
| Refresh Capabilities | Update available models | |
| Refresh Voices | Update TTS voice list |
6. Common Scenarios & Examples
Scenario 1: Add OpenAI Provider
- Click Create New
- Provider = OpenAI
- Name = "Main OpenAI"
- API Key = sk-xxxxxx (from OpenAI dashboard)
- Organization = (optional for teams)
- Enabled = ✓
- Test Connection
- Save Provider
Scenario 2: Add ElevenLabs for Voice
- Create New
- Provider = ElevenLabs
- Name = "ElevenLabs TTS"
- API Key = (from ElevenLabs dashboard)
- Test Connection
- Refresh Voices
- Save
Scenario 3: Configure Azure OpenAI
- Create New
- Provider = Azure OpenAI
- Name = "Enterprise OpenAI"
- API Key = (from Azure portal)
- Base URL = https://my-resource.openai.azure.com/
- Test Connection
- Save
Scenario 4: Self-Hosted Model
- Create New
- Provider = OpenAI (compatible API)
- Name = "Local LLM"
- API Key = (local key if required)
- Base URL = http://localhost:8000/v1
- Test Connection
- Save
---
7. Limitations & Important Notes
Technical Notes
NOTE
Single Provider Per Type: One active provider per type.NOTE
Base URL: Override for proxies or self-hosted.WARNING
API Key Security: Keys stored encrypted but treat carefully.Best Practices
- Test After Adding: Always verify with Test Connection
- Use Descriptive Names: "Production OpenAI" vs "Test"
- Rotate Keys: Update keys periodically
- Monitor Usage: Watch API billing
- Disable Unused: Disable inactive providers
Provider Capabilities
| Provider | TTS | STT | LLM | Voice Clone | |
|---|---|---|---|---|---|
| OpenAI | ✓ | ✓ | ✓ | ✗ | |
| ElevenLabs | ✓ | ✗ | ✗ | ✓ | |
| Anthropic | ✗ | ✗ | ✓ | ✗ | |
| ✓ | ✓ | ✓ | ✗ | ||
| Azure | ✓ | ✓ | ✓ | ✗ |
8. Troubleshooting Tips
Common Issues
| Symptom | Possible Cause | Solution | |
|---|---|---|---|
| Test failed | Invalid key | Check API key | |
| 401 error | Expired key | Regenerate key | |
| 403 error | Wrong org ID | Verify organization | |
| Timeout | Network issue | Check connectivity |
Test API Keys
Check Provider Status
---
9. Glossary
| Term | Definition | |
|---|---|---|
| API Key | Authentication credential | |
| Provider | AI service vendor | |
| Base URL | API endpoint | |
| TTS | Text-to-Speech | |
| STT | Speech-to-Text | |
| LLM | Large Language Model |
Lua Script Status ℹ️
Integration Module
| Component | Status |
|---|---|
| AI Providers | ℹ️ Credential storage - no Lua handler required |
---
Documentation last updated: January 2026