AI Configuration
BreakGround includes AI-powered features that help you create and optimize digital adoption content. Configure your AI provider and API key from Settings > AI Configuration.
Available AI Features
- Content suggestions -- AI-generated text for tooltip copy, survey questions, and announcement content.
- Flow optimization -- Recommendations to improve flow completion rates based on analytics data.
- Auto-localization -- Automated translation of content into your configured locales.
- Smart analytics summaries -- Natural language summaries of analytics trends and anomalies.
The ai_assistant feature is available on the ENTERPRISE plan. The byok_ai_provider feature is available on PRO and ENTERPRISE plans.
Bring Your Own Key (BYOK) Setup
BYOK lets you use your own AI provider API key so that all AI requests go through your account.
Supported Providers
| Provider | Value | Key Format |
|---|---|---|
| OpenAI | OPENAI | sk-... |
| Google Gemini | GEMINI | AI... |
| Anthropic Claude | CLAUDE | sk-ant-... |
Adding Your Key
- Navigate to Settings > AI Configuration.
- Select your AI provider from the dropdown.
- Paste your API key.
- Click Save. BreakGround validates the key by making a test request to the provider.
Your API key is encrypted with AES-256-GCM before storage. The dashboard displays only a masked version (e.g., sk-...abcd) after saving.
Key Encryption and Security
- Keys are encrypted at rest using AES-256-GCM with a per-company encryption context.
- The plaintext key is never stored or logged.
- Only the last 4 characters are shown in the dashboard for identification.
Fallback Behavior
If your custom API key fails (expired, revoked, or rate-limited by the provider), BreakGround falls back to the system-provided AI key to avoid disrupting your workflow. A warning is displayed in the dashboard when the fallback is active.
Testing Your Configuration
After saving your key, click Test Connection to verify:
- The key is valid and has sufficient permissions.
- The selected provider responds within acceptable latency.
- AI features are operational with your key.
A success or failure message is displayed immediately.
Disabling AI Features
Toggle AI Enabled off in the AI Configuration page to disable all AI features company-wide. Your saved key is retained and can be re-enabled at any time.