Bring Your Own Model (BYOM) routes your org's SalesWings AI Sales Assistant and Copilot conversations through an approved provider using your organization's credentials.
BYOM is optional and applies to the whole Salesforce org. While it is disabled, the SalesWings AI Sales Assistant and Copilot uses the SalesWings-managed model configuration.
Before you begin
You need:
SW AI Sales Agent Admin
A Connected status under SW AI Sales Agent Settings → Connection
An active account and valid API key for the selected provider
Approval under your organization's AI, privacy, security, and data-location policies
For Azure OpenAI, the Azure resource endpoint and deployment name
Providers and models are curated by SalesWings and may change.
Enable BYOM
Open the App Launcher and select SW AI Sales Agent Settings.
Confirm that Connection shows Connected.
Select Bring Your Own Model.
Turn on Bring Your Own Model.
Select a provider and model.
Enter the API key under Replace API key.
Complete any provider-specific fields.
Select Save.
Confirm that Current API key shows a configured key.
Clear the test record's conversation, start a new one, and send a message.
API-key handling
The complete key is not displayed after it is saved.
The backend encrypts the key before storing it.
Leave Replace API key blank to retain the current key when changing compatible settings.
Enter a new key to rotate it.
The field is cleared after every save attempt; re-enter the key if a save fails.
Changing provider requires a new key.
Changing an Azure OpenAI endpoint also requires a new key.
Disabling BYOM deletes the BYOM configuration and encrypted key.
Configure Azure OpenAI
Provide:
Base model — the approved model family behind the deployment
Azure endpoint — the Azure resource root
Azure deployment name — the name configured in Azure
Replace API key — the key for the Azure resource
Example endpoint:
https://your-resource.openai.azure.com
The endpoint must use HTTPS, use a supported openai.azure.com or services.ai.azure.com host, and contain no API path, query, fragment, credentials, or custom port.
The deployment name does not need to match the base model. Replace the suggested deployment name if your Azure configuration uses another name.
Existing conversations after a change
New conversations use the active configuration.
Existing conversations remain SalesWings-managed or BYOM according to how they were created.
Existing standard BYOM conversations continue to use their original provider and model with the org's current compatible credentials. Existing Azure OpenAI conversations use the org's current Azure configuration.
If the required configuration is no longer available, restore a compatible configuration or clear the conversation and start a new one.
BYOM conversations never fall back to a SalesWings-managed provider.
Rotate a key
Open SW AI Sales Agent Settings → Bring Your Own Model.
Enter the new key under Replace API key.
Select Save.
Confirm the masked key status and test a new conversation.
Disable BYOM
Open Bring Your Own Model.
Turn off Bring Your Own Model.
Select Save.
Clear the test conversation and start a new one.
Disabling BYOM removes its configuration and key. It does not delete or convert existing conversations.
Troubleshooting
Settings do not load: Confirm that the org is connected and you have SW AI Sales Agent Admin.
Provider rejects a request: Check the key, account status, quota, provider, and model.
Azure endpoint is rejected: Enter only the HTTPS resource root on a supported Azure hostname.
An existing conversation fails: Restore a compatible configuration or clear it and start again.