BYO AI Key Salesforce Documentation
How Bring-Your-Own-Key AI models preserve security and reduce costs in Salesforce analysis.
Definition
BYO AI Key (Bring Your Own Key) is an operational model where the customer enters their own AI provider credentials (such as Google Gemini or OpenAI) to run generative tasks, paying only raw API costs directly to the provider.
Overview & Context
Generative AI tools often markup API costs heavily or route prompts through proprietary proxies that record your queries. For enterprise codebases, this adds both financial overhead and security risks. SF Analyzer adopts a BYO-key model, executing direct API calls from the desktop client to the model endpoint.
Important Architecture Notice
SF Analyzer strictly enforces the local data boundary. Your Salesforce metadata, credentials, and source files never leave your system.
TL;DR (Too Long; Didn't Read)
Connect your private AI provider keys directly to the desktop app to generate custom documentation, avoiding markup fees and data leakage.
Key Advantages
- Keychain SecurityKeys are stored in system-level keychain (AppKey/safeStorage), never exposed to the UI.
- Raw API CostsZero markup fees. You pay only for the exact tokens consumed in your analyses.
- No Intermediate ProxiesRequests go straight from your IP to the AI provider's endpoint.
Typical Use Case
Organizations with existing corporate agreements with Google Cloud, AWS, or OpenAI who want to leverage those contracts for Salesforce analysis.
Analysis Workflow
Enter your private API key in the Settings screen of the desktop app.
The app securely encrypts the key using your system's Keychain (safeStorage).
When running wiki generation, the desktop app initiates direct API requests to the provider.
Your code is processed according to your specific AI provider's API privacy policy (usually excluding training).
How It Compares
Compare the secure local-first workflow against traditional cloud-based SaaS vendors.
| AI Aspect | SaaS Copilot Subscriptions | BYO-Key Model (SF Analyzer) |
|---|---|---|
| Billing Model | Fixed monthly fee per user (often marked up) | Pay-as-you-go based on raw model tokens consumed |
| Key Storage | Stored on the vendor's cloud server | Stored in local operating system keychain |
| Network Route | Client -> Vendor Proxy -> AI Provider | Desktop Client -> AI Provider (Direct) |
| Data Policies | Subject to vendor terms; might log prompts | Governed by your direct enterprise agreement with the AI provider |
Frequently Asked Questions
Find answers to technical and operational questions about BYO AI Key Salesforce Documentation.
Q:How do I get an API key?
You can create an API key in the developer console of your chosen provider: Google AI Studio (for Gemini), OpenAI Platform, or Anthropic Console.
Q:Is my API key sent to the SF Analyzer portal?
No. Your API key remains strictly on your local machine, stored in the OS keychain. The SF Analyzer cloud portal has no access to your key or your AI billing.
Ready to assess your Salesforce Org?
Download the SF Analyzer desktop application. Connect your sandbox or production org via the CLI, and run the assessment 100% locally.