AI Assistant
The Welkin AI integration connects each Welkin instance to an external AI provider so that AI-powered features — such as AI-generated patient summaries in the Care Portal — are available to care team members.
Prerequisites
Before configuring Welkin AI, confirm that the Welkin AI license is enabled for your organization. Contact your Welkin Implementation Manager or CSM if you are unsure.
Accessing the Welkin AI Configuration
Log in to the Admin Portal.
Navigate to Integrations → Welkin AI.
A card is shown for each instance in your organization.
Configuring an Instance
Each instance must be configured separately.
Click the edit (pencil) icon on the instance card.
A configuration drawer opens with the following fields:
API Key
The API key issued by your AI provider. Required.
Provider
Select the AI provider from the available list. Required.
Model
Select the model offered by the chosen provider. Required. The model list updates when you change the provider. Deprecated models are shown but cannot be selected for new configurations.
Click Save to apply the configuration.
Welkin validates the API key against the selected provider when you save. If the key is invalid or cannot be reached, the save will fail with an error — correct the key before retrying.
After saving, the card displays the masked API key, provider name, and model.
Available Models
OpenAI
GPT-5.6 Terra
Standard workhorse model
OpenAI
GPT-5.6 Luna
Cost-optimized tier
Anthropic
Claude Sonnet 5
Primary Anthropic model; near-Opus quality at Sonnet price
Anthropic
Claude Opus 5
Premium Anthropic model
Anthropic
Claude Haiku 4.5
Lightweight Anthropic model
Note for existing configurations: If your instance was previously configured with an older model (GPT-5.4, GPT-5.4 Mini, GPT-5.4 Nano, Claude Sonnet 4.6, or Claude Opus 4.6), it has been automatically migrated to the closest current equivalent. No action is required — your AI features will continue to work.
Speech-to-Text (STT) Configuration
If your organization has the voice/STT add-on enabled, you can configure a speech-to-text provider for each instance. The STT provider is used to transcribe audio recordings submitted via the audio transcription feature.
The STT configuration fields are:
STT Provider
Select the speech-to-text provider (e.g., OpenAI). Must be set if an STT API Key is provided.
STT Model
The transcription model to use (e.g., whisper-1). Optional — defaults to the provider's standard model if left blank.
STT API Key
The API key for the STT provider. Required when an STT Provider is selected.
Validation rules: The STT Provider and STT API Key must either both be set or both be left blank. Saving a configuration with a provider but no API key, or an API key but no provider, returns a
STT_CONFIG_INCOMPLETEvalidation error. Welkin also validates the STT API key against the provider at save time — an invalid key will prevent the configuration from being saved.
Removing the STT configuration: To remove a previously saved STT block and return the instance to the chat-provider fallback, clear both the STT Provider and STT API Key fields and save. You can also send
"stt": nullvia the API PATCH endpoint to clear the STT block.
Chat provider fallback: If no STT block is configured, Welkin automatically uses the chat provider's speech-to-text service when one is available (for example, an OpenAI chat configuration will fall back to OpenAI Whisper). Providers that do not offer a speech-to-text API (such as Anthropic) have no fallback — audio transcription will return a service unavailable error until an explicit STT block is configured.
Updating a Configuration
Click the edit icon on the instance card.
Modify any field and click Save.
Deleting a Configuration
Click the trash icon on the instance card.
A confirmation prompt appears: "Delete this Welkin AI config?" Click Yes, Delete to confirm, or No, Keep it to cancel.
After deletion, the AI features powered by this instance will no longer function until a new configuration is saved.
Related Topics
Last updated
Was this helpful?