Bring Your Own Key (BYOK)
Configure your own API key for OpenAI, Sarvam, Anthropic, or Google DeepMind. When active, all AI features in your workspace use your key and your provider account.
BYOK lets a workspace admin replace Edilitics' shared AI provider with their own API key for OpenAI, Sarvam, Anthropic, or Google DeepMind. Once active, every AI feature in the workspace is routed through the configured key. The API key is stored encrypted and decrypted only at the moment each AI request is made.
BYOK is a permanent configuration change. Once a key is set, it cannot be removed through the settings interface. If you need to revert to Edilitics' provider, contact support.
Supported Providers
| Provider | Required key format |
|---|---|
| OpenAI | sk-proj- followed by 80 or more characters |
| Sarvam | A standard UUID: 32 hexadecimal characters in 8-4-4-4-12 groups |
| Anthropic | sk-ant-api followed by version digits and 80 or more characters |
| Google DeepMind | AIza followed by 35 alphanumeric characters |
The key format is validated locally before any request is made to the provider.
How to Set Up BYOK
Go to Organisation Settings and open the LLM Provider section.
Select the provider you want to configure: OpenAI, Sarvam, Anthropic, or Google DeepMind.
Paste your API key into the field. The key format is validated against the expected pattern for the selected provider before the test can proceed.
Click the test button. Edilitics verifies that the key is active and that the models Edilitics uses are accessible on your account. If the test fails, the key is not saved.
Review the feature summary. The configuration screen shows which AI features will be routed through your key: AskEdi, AI Column Insights, and AI Chart Suggestions. All features are enabled and cannot be toggled individually.
Click Save Configuration. The key is encrypted and stored. All AI requests in the workspace are now routed through your provider account.
What Changes After Setup
Once a BYOK key is active:
- All AI features in the workspace use your key and your provider account. This covers AskEdi, AI Column Insights in Integrate, Auto-Generate Charts and dashboard Summarise in Visualize, and AI transform suggestions in Transform.
- AI requests consume your provider quota, not Edilitics' shared quota.
- Your monthly analysis credits double, and stay doubled for as long as BYOK is active. Because one credit pool powers every AI feature listed above, the doubling applies across all of them, not to AskEdi alone. See Analysis Credits for how the allocation works.
- Each provider is pinned to one fixed model. A stored key always targets that model, and there is no model selector during setup or afterwards.
- Your API key is stored encrypted at rest using your workspace's per-workspace encryption key.
Which model your key targets
Edilitics selects one model per provider and keeps it current, moving to a newer model when a materially better one becomes available. The model in use is not configurable, and it is not published here, so that upgrades do not depend on documentation being updated first.
The setup screen tells you what you need to know at the point it matters: when you test your key, Edilitics verifies that your account can reach the model in use for that provider. If it cannot, the test fails and the key is not saved, with the reason shown on screen.
Use a key from an account with general model access for that provider rather than one restricted to a specific model. A key scoped to a single older model may pass today and fail after a model upgrade.
If the key test fails, check your provider console for model access restrictions on that key, then test again. A key is never saved until it passes.
Provider Logging
OpenAI, Anthropic, and Google DeepMind do not use API request data to train their models by default. API users are opted out of training unless they explicitly enrol in a provider data-sharing programme. For Sarvam, review your own account's data policy directly, since Edilitics does not control or attest to a third-party provider's training practices.
The concern with BYOK is request logging for your own visibility. If you have enabled request logging in your provider's dashboard, your API requests will be stored in your provider account's logs. This includes schema metadata (table names, column names, statistics) sent by Edilitics with each request. Edilitics does not control whether you have this enabled.
If request logging is enabled in your provider's dashboard, every AI request made through your BYOK key will be visible in those logs, including schema metadata sent by Edilitics. Review your logging settings before activating BYOK if this is a concern.
| Provider | Where to review logging settings |
|---|---|
| OpenAI | platform.openai.com under Settings: review Data Controls and audit logging |
| Sarvam | dashboard.sarvam.ai under key management: review your account's data retention and logging policy |
| Anthropic | platform.claude.com: API data is not used for training by default; review any opt-in programmes |
| Google DeepMind | aistudio.google.com under project settings: logging is opt-in; paid API users are not trained on by default |
Frequently Asked Questions
Related Docs
Data Encryption
How all stored data, including BYOK API keys, is encrypted at rest using per-workspace key derivation.
Privacy & Context Modes
Control exactly what schema context is sent to your LLM provider across AskEdi, Visualize, and Integrate.
Audit Logs
Every action in your workspace logged with user, timestamp, and description.
Need help? Email support@edilitics.com with your workspace, job ID, and context. We reply within one business day.
Last updated on