byok-setup

Bring Your Own Key (BYOK) allows you to use your own API keys for AI providers, giving you control over costs and access to specific models.

Supported Providers

Provider	Category	Use For
Deepgram	STT	Speech-to-Text
OpenAI	LLM	Language Model
ElevenLabs	TTS	Text-to-Speech
Resend	Email	Notifications

Step 1: Get Your API Keys

Deepgram (STT)

Create an API key with "Member" role

Copy the key (it won't be shown again)

OpenAI (LLM)

Go to https://platform.openai.com/api-keys

Click "Create new secret key"

Copy the key (starts with sk-)

ElevenLabs (TTS)

Go to https://elevenlabs.io/app/settings/api-keys

Click "Create API Key"

Copy the key

Resend (Email)

Go to https://resend.com/api-keys

Click "Create API Key"

Copy the key (starts with re_)

Step 2: Add BYOK Configuration

Add your API key via the API:

Repeat for each provider you want to configure.

Step 3: Verify Configuration

Check which providers are configured:

Response:

{
  "byok_keys": {
    "deepgram_secret_id": "vault-id-1",
    "openai_secret_id": "vault-id-2",
    "elevenlabs_secret_id": null,
    "resend_secret_id": null
  }
}

A non-null value means the provider is configured.

Step 4: Configure Your Assistant

Create or update your assistant to use the provider:

Available Models

Check available models for each provider:

Important Notes for ElevenLabs

When using ElevenLabs with BYOK:

Voice Library Only - You only have access to voices in your ElevenLabs Voice Library

No Public Voices - You don't automatically get access to all public ElevenLabs voices

Add Voices First - Before using a voice, add it to your library at https://elevenlabs.io/app/voice-library

Voice IDs - Use the voice ID from your ElevenLabs dashboard

Removing BYOK Configuration

To remove a provider and go back to HMS Sovereign's default keys:

Security

API keys are stored securely and encrypted at rest

Keys are never exposed in API responses

Only encrypted references are stored in your account

You can rotate keys at any time by adding a new key for the same provider

See BYOK API Reference for complete details.

Supported Providers#

Step 1: Get Your API Keys#

Deepgram (STT)#

OpenAI (LLM)#

ElevenLabs (TTS)#

Resend (Email)#

Step 2: Add BYOK Configuration#

Step 3: Verify Configuration#

Step 4: Configure Your Assistant#

Available Models#

Important Notes for ElevenLabs#

Removing BYOK Configuration#

Security#