> ## Documentation Index
> Fetch the complete documentation index at: https://www.voiceflow.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Voice settings

> Read and update an Environment’s speech and phone-session configuration.

## Purpose

These operations manage Environment configuration; they do not start a customer conversation. Use the [API task guide](/docs/guides/developers/voice/configure-voice) for a complete update. The concrete route is `v1alpha1`, served by `realtime-api.voiceflow.com`.

## Authentication

Use a Voiceflow API key on your server. GET requires `project.versions:READ`; PATCH requires `project:UPDATE`. The target is an Environment version ID, not an alias. The operation examples use the `realtime-api.voiceflow.com` host.

## Operations

### Read Voice settings

#### Get environment voice settings

Read the selected Environment’s Voice settings. Requires project.versions:READ.

##### Endpoint

```http
GET /v1alpha1/environment/{environmentID}/settings/voice
```

Server: https://realtime-api.voiceflow.com

##### Authentication

```json
[
  {
    "auth": []
  }
]
```

`auth`:

```json
{
  "type": "apiKey",
  "in": "header",
  "name": "authorization",
  "description": "Voiceflow API key"
}
```

##### Path parameters

###### `environmentID`

Required · string

```json
{
  "type": "string"
}
```

##### Responses

###### 200

Schema:

```json
{
  "$ref": "#/components/schemas/EnvironmentVoiceSettingsResponse"
}
```

Example:

```json
{
  "voice": {
    "stt": "<ElevenLabsSTTSettings>",
    "tts": "<AmazonVoiceSettings>",
    "pronunciationDictionary": [
      {
        "from": "<string>",
        "to": "<string>"
      }
    ],
    "failureMessage": "<string>",
    "hasCallRecording": true,
    "audioCue": 0,
    "backgroundAudio": "<string>",
    "backgroundAudioSettings": {
      "volume": 0.75
    },
    "audioSync": true,
    "keypadInput": {
      "enabled": true,
      "delimiter": [
        "<DTMFDelimiter>"
      ],
      "timeoutInSeconds": 0
    },
    "silenceTimeoutMs": 0,
    "maxDuration": {
      "enabled": true,
      "seconds": 0,
      "message": "<string>"
    },
    "callerIdentity": "phone-number",
    "localeOverrides": [
      {
        "locale": "<string>",
        "tts": "<VoiceSettings>"
      }
    ],
    "hasProviderCallRecording": true
  }
}
```

###### 401

Missing or invalid authentication.

###### 403

API key lacks the required project permission.

###### 404

Environment not found, or Environment has no Voice settings.

##### Request examples

###### cURL

```bash
curl --request GET \
  --url 'https://realtime-api.voiceflow.com/v1alpha1/environment/<environmentID>/settings/voice' \
  --header 'Authorization: <api-key>'
```

###### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1alpha1/environment/<environmentID>/settings/voice', {
  method: 'GET',
  headers: {
    Authorization: '<api-key>',
  },
});
const data = await response.json();
```

###### Python

```python
import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1alpha1/environment/<environmentID>/settings/voice',
    headers={'Authorization': '<api-key>'},
)
data = response.json()
```

##### Schema definitions

###### AmazonVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "amazon"
      ],
      "x-enumNames": [
        "AMAZON"
      ]
    },
    "voice": {
      "type": "string"
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

###### AssemblyAISTTLanguage

```json
{
  "type": "string",
  "enum": [
    "multi",
    "en",
    "ar",
    "da",
    "nl",
    "fi",
    "fr",
    "de",
    "he",
    "hi",
    "it",
    "ja",
    "zh",
    "no",
    "pt",
    "es",
    "sv",
    "tr",
    "vi"
  ],
  "x-enumNames": [
    "MULTI",
    "ENGLISH",
    "ARABIC",
    "DANISH",
    "DUTCH",
    "FINNISH",
    "FRENCH",
    "GERMAN",
    "HEBREW",
    "HINDI",
    "ITALIAN",
    "JAPANESE",
    "MANDARIN",
    "NORWEGIAN",
    "PORTUGUESE",
    "SPANISH",
    "SWEDISH",
    "TURKISH",
    "VIETNAMESE"
  ]
}
```

###### AssemblyAISTTMode

```json
{
  "type": "string",
  "enum": [
    "min_latency",
    "balanced",
    "max_accuracy"
  ],
  "x-enumNames": [
    "MIN_LATENCY",
    "BALANCED",
    "MAX_ACCURACY"
  ]
}
```

###### AssemblyAISTTModel

```json
{
  "type": "string",
  "enum": [
    "universal-streaming-english",
    "universal-3-5-pro"
  ],
  "x-enumNames": [
    "UNIVERSAL_STREAMING_ENGLISH",
    "UNIVERSAL_3_5_PRO"
  ]
}
```

###### AssemblyAISTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "assemblyai"
      ],
      "x-enumNames": [
        "ASSEMBLYAI"
      ]
    },
    "model": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssemblyAISTTModel"
        }
      ]
    },
    "mode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssemblyAISTTMode"
        }
      ]
    },
    "language": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssemblyAISTTLanguage"
        }
      ]
    },
    "keyterms": {
      "type": "string"
    },
    "confidenceThreshold": {
      "default": 0.7,
      "type": "number"
    },
    "maxTurnSilence": {
      "default": 2400,
      "type": "number"
    },
    "minTurnSilence": {
      "default": 160,
      "type": "number"
    }
  },
  "required": [
    "provider"
  ]
}
```

###### BackgroundAudioSettings

```json
{
  "type": "object",
  "properties": {
    "volume": {
      "default": 0.75,
      "type": "number",
      "minimum": 0,
      "maximum": 1
    }
  }
}
```

###### CartesiaSTTLanguage

```json
{
  "type": "string",
  "enum": [
    "en",
    "af",
    "ar",
    "hy",
    "az",
    "be",
    "bs",
    "bg",
    "ca",
    "zh",
    "hr",
    "cs",
    "da",
    "nl",
    "et",
    "fi",
    "fr",
    "gl",
    "de",
    "el",
    "he",
    "hi",
    "hu",
    "is",
    "id",
    "it",
    "ja",
    "kn",
    "kk",
    "ko",
    "lv",
    "lt",
    "mk",
    "ms",
    "mr",
    "mi",
    "ne",
    "no",
    "fa",
    "pl",
    "pt",
    "ro",
    "ru",
    "sr",
    "sk",
    "sl",
    "es",
    "sw",
    "sv",
    "tl",
    "ta",
    "th",
    "tr",
    "uk",
    "ur",
    "vi",
    "cy"
  ],
  "x-enumNames": [
    "ENGLISH",
    "AFRIKAANS",
    "ARABIC",
    "ARMENIAN",
    "AZERBAIJANI",
    "BELARUSIAN",
    "BOSNIAN",
    "BULGARIAN",
    "CATALAN",
    "CHINESE",
    "CROATIAN",
    "CZECH",
    "DANISH",
    "DUTCH",
    "ESTONIAN",
    "FINNISH",
    "FRENCH",
    "GALICIAN",
    "GERMAN",
    "GREEK",
    "HEBREW",
    "HINDI",
    "HUNGARIAN",
    "ICELANDIC",
    "INDONESIAN",
    "ITALIAN",
    "JAPANESE",
    "KANNADA",
    "KAZAKH",
    "KOREAN",
    "LATVIAN",
    "LITHUANIAN",
    "MACEDONIAN",
    "MALAY",
    "MARATHI",
    "MAORI",
    "NEPALI",
    "NORWEGIAN",
    "PERSIAN",
    "POLISH",
    "PORTUGUESE",
    "ROMANIAN",
    "RUSSIAN",
    "SERBIAN",
    "SLOVAK",
    "SLOVENIAN",
    "SPANISH",
    "SWAHILI",
    "SWEDISH",
    "TAGALOG",
    "TAMIL",
    "THAI",
    "TURKISH",
    "UKRAINIAN",
    "URDU",
    "VIETNAMESE",
    "WELSH"
  ]
}
```

###### CartesiaSTTModel

```json
{
  "type": "string",
  "enum": [
    "ink-whisper",
    "ink-2"
  ],
  "x-enumNames": [
    "INK_WHISPER",
    "INK_2"
  ]
}
```

###### CartesiaSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "cartesia"
      ],
      "x-enumNames": [
        "CARTESIA"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/CartesiaSTTModel"
    },
    "language": {
      "$ref": "#/components/schemas/CartesiaSTTLanguage"
    }
  },
  "required": [
    "provider",
    "model",
    "language"
  ]
}
```

###### CartesiaVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "cartesia"
      ],
      "x-enumNames": [
        "CARTESIA"
      ]
    },
    "model": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "settings": {
      "type": "object",
      "properties": {
        "speed": {
          "type": "number",
          "minimum": 0.6,
          "maximum": 1.5
        }
      }
    }
  },
  "required": [
    "provider",
    "model",
    "voice"
  ]
}
```

###### DTMFDelimiter

```json
{
  "type": "string",
  "enum": [
    "#",
    "*"
  ],
  "x-enumNames": [
    "#",
    "*"
  ]
}
```

###### DeepgramSTTLanguage

```json
{
  "type": "string",
  "enum": [
    "multi",
    "ar",
    "ar-AE",
    "ar-DZ",
    "ar-EG",
    "ar-IQ",
    "ar-IR",
    "ar-JO",
    "ar-KW",
    "ar-LB",
    "ar-MA",
    "ar-PS",
    "ar-QA",
    "ar-SA",
    "ar-SD",
    "ar-SY",
    "ar-TD",
    "ar-TN",
    "be",
    "bg",
    "bn",
    "bs",
    "ca",
    "cs",
    "da",
    "da-DK",
    "de",
    "de-CH",
    "el",
    "en",
    "en-AU",
    "en-GB",
    "en-IN",
    "en-NZ",
    "en-US",
    "es",
    "es-419",
    "et",
    "fa",
    "fi",
    "fr",
    "fr-CA",
    "he",
    "hi",
    "hr",
    "hu",
    "id",
    "it",
    "ja",
    "kn",
    "ko",
    "ko-KR",
    "lt",
    "lv",
    "mk",
    "mr",
    "ms",
    "nl",
    "nl-BE",
    "no",
    "pl",
    "pt",
    "pt-BR",
    "pt-PT",
    "ro",
    "ru",
    "sk",
    "sl",
    "sr",
    "sv",
    "sv-SE",
    "ta",
    "te",
    "th",
    "tl",
    "tr",
    "uk",
    "ur",
    "vi",
    "zh",
    "zh-HK",
    "zh-TW"
  ],
  "x-enumNames": [
    "MULTI",
    "AR",
    "AR_AE",
    "AR_DZ",
    "AR_EG",
    "AR_IQ",
    "AR_IR",
    "AR_JO",
    "AR_KW",
    "AR_LB",
    "AR_MA",
    "AR_PS",
    "AR_QA",
    "AR_SA",
    "AR_SD",
    "AR_SY",
    "AR_TD",
    "AR_TN",
    "BE",
    "BG",
    "BN",
    "BS",
    "CA",
    "CS",
    "DA",
    "DA_DK",
    "DE",
    "DE_CH",
    "EL",
    "EN",
    "EN_AU",
    "EN_GB",
    "EN_IN",
    "EN_NZ",
    "EN_US",
    "ES",
    "ES_419",
    "ET",
    "FA",
    "FI",
    "FR",
    "FR_CA",
    "HE",
    "HI",
    "HR",
    "HU",
    "ID",
    "IT",
    "JA",
    "KN",
    "KO",
    "KO_KR",
    "LT",
    "LV",
    "MK",
    "MR",
    "MS",
    "NL",
    "NL_BE",
    "NO",
    "PL",
    "PT",
    "PT_BR",
    "PT_PT",
    "RO",
    "RU",
    "SK",
    "SL",
    "SR",
    "SV",
    "SV_SE",
    "TA",
    "TE",
    "TH",
    "TL",
    "TR",
    "UK",
    "UR",
    "VI",
    "ZH",
    "ZH_HK",
    "ZH_TW"
  ]
}
```

###### DeepgramSTTModel

```json
{
  "type": "string",
  "enum": [
    "nova-2",
    "nova-3",
    "nova-3-medical",
    "flux"
  ],
  "x-enumNames": [
    "NOVA_2",
    "NOVA_3",
    "NOVA_3_MEDICAL",
    "FLUX"
  ]
}
```

###### DeepgramSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "deepgram"
      ],
      "x-enumNames": [
        "DEEPGRAM"
      ]
    },
    "model": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeepgramSTTModel"
        }
      ]
    },
    "locale": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeepgramSTTLanguage"
        }
      ]
    },
    "keywords": {
      "type": "string"
    },
    "partialWaitMS": {
      "type": "number"
    },
    "silenceWaitMS": {
      "type": "number"
    },
    "punctuationWaitMS": {
      "type": "number"
    },
    "interruptionWaitWords": {
      "type": "number"
    },
    "EOTTimeout": {
      "type": "number"
    },
    "EOTThreshold": {
      "type": "number"
    },
    "languageHints": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DeepgramSTTLanguage"
      }
    }
  },
  "required": [
    "provider"
  ]
}
```

###### ElevenLabsSTTLanguage

```json
{
  "type": "string",
  "enum": [
    "afr",
    "amh",
    "ara",
    "hye",
    "asm",
    "ast",
    "aze",
    "bel",
    "ben",
    "bos",
    "bul",
    "mya",
    "yue",
    "cat",
    "ceb",
    "nya",
    "hrv",
    "ces",
    "dan",
    "nld",
    "eng",
    "est",
    "fil",
    "fin",
    "fra",
    "ful",
    "glg",
    "lug",
    "kat",
    "deu",
    "ell",
    "guj",
    "hau",
    "heb",
    "hin",
    "hun",
    "isl",
    "ibo",
    "ind",
    "gle",
    "ita",
    "jpn",
    "jav",
    "kea",
    "kan",
    "kaz",
    "khm",
    "kor",
    "kur",
    "kir",
    "lao",
    "lav",
    "lin",
    "lit",
    "luo",
    "ltz",
    "mkd",
    "msa",
    "mal",
    "mlt",
    "zho",
    "mri",
    "mar",
    "mon",
    "nep",
    "nso",
    "nor",
    "oci",
    "ori",
    "pus",
    "fas",
    "pol",
    "por",
    "pan",
    "ron",
    "rus",
    "srp",
    "sna",
    "snd",
    "slk",
    "slv",
    "som",
    "spa",
    "swa",
    "swe",
    "tam",
    "tgk",
    "tel",
    "tha",
    "tur",
    "ukr",
    "umb",
    "urd",
    "uzb",
    "vie",
    "cym",
    "wol",
    "xho",
    "zul"
  ],
  "x-enumNames": [
    "AFRIKAANS",
    "AMHARIC",
    "ARABIC",
    "ARMENIAN",
    "ASSAMESE",
    "ASTURIAN",
    "AZERBAIJANI",
    "BELARUSIAN",
    "BENGALI",
    "BOSNIAN",
    "BULGARIAN",
    "BURMESE",
    "CANTONESE",
    "CATALAN",
    "CEBUANO",
    "CHICHEWA",
    "CROATIAN",
    "CZECH",
    "DANISH",
    "DUTCH",
    "ENGLISH",
    "ESTONIAN",
    "FILIPINO",
    "FINNISH",
    "FRENCH",
    "FULAH",
    "GALICIAN",
    "GANDA",
    "GEORGIAN",
    "GERMAN",
    "GREEK",
    "GUJARATI",
    "HAUSA",
    "HEBREW",
    "HINDI",
    "HUNGARIAN",
    "ICELANDIC",
    "IGBO",
    "INDONESIAN",
    "IRISH",
    "ITALIAN",
    "JAPANESE",
    "JAVANESE",
    "KABUVERDIANU",
    "KANNADA",
    "KAZAKH",
    "KHMER",
    "KOREAN",
    "KURDISH",
    "KYRGYZ",
    "LAO",
    "LATVIAN",
    "LINGALA",
    "LITHUANIAN",
    "LUO",
    "LUXEMBOURGISH",
    "MACEDONIAN",
    "MALAY",
    "MALAYALAM",
    "MALTESE",
    "MANDARIN_CHINESE",
    "MAORI",
    "MARATHI",
    "MONGOLIAN",
    "NEPALI",
    "NORTHERN_SOTHO",
    "NORWEGIAN",
    "OCCITAN",
    "ODIA",
    "PASHTO",
    "PERSIAN",
    "POLISH",
    "PORTUGUESE",
    "PUNJABI",
    "ROMANIAN",
    "RUSSIAN",
    "SERBIAN",
    "SHONA",
    "SINDHI",
    "SLOVAK",
    "SLOVENIAN",
    "SOMALI",
    "SPANISH",
    "SWAHILI",
    "SWEDISH",
    "TAMIL",
    "TAJIK",
    "TELUGU",
    "THAI",
    "TURKISH",
    "UKRAINIAN",
    "UMBUNDU",
    "URDU",
    "UZBEK",
    "VIETNAMESE",
    "WELSH",
    "WOLOF",
    "XHOSA",
    "ZULU"
  ]
}
```

###### ElevenLabsSTTModel

```json
{
  "type": "string",
  "enum": [
    "scribe_v2_realtime"
  ],
  "x-enumNames": [
    "SCRIBE_V_2_REALTIME"
  ]
}
```

###### ElevenLabsSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "elevenlabs"
      ],
      "x-enumNames": [
        "ELEVENLABS"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/ElevenLabsSTTModel"
    },
    "language": {
      "$ref": "#/components/schemas/ElevenLabsSTTLanguage"
    },
    "commitStrategy": {
      "type": "string",
      "enum": [
        "vad",
        "manual"
      ],
      "x-enumNames": [
        "VAD",
        "MANUAL"
      ]
    },
    "vadSilenceThresholdSecs": {
      "type": "number",
      "minimum": 0.3,
      "maximum": 3
    },
    "vadThreshold": {
      "type": "number",
      "minimum": 0.1,
      "maximum": 0.9
    },
    "minSpeechDurationMS": {
      "type": "number",
      "minimum": 50,
      "maximum": 2000
    },
    "minSilenceDurationMS": {
      "type": "number",
      "minimum": 50,
      "maximum": 2000
    }
  },
  "required": [
    "provider",
    "model",
    "language"
  ]
}
```

###### ElevenLabsVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "elevenlabs"
      ],
      "x-enumNames": [
        "ELEVENLABS"
      ]
    },
    "model": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "useCustomVoice": {
      "type": "boolean"
    },
    "settings": {
      "type": "object",
      "properties": {
        "speed": {
          "type": "number",
          "minimum": 0.7,
          "maximum": 1.3
        },
        "style": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "stability": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "speaker_boost": {
          "type": "boolean"
        },
        "similarity_boost": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        }
      }
    },
    "pronunciation_dictionaries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "pronunciation_dictionary_id": {
            "type": "string"
          },
          "version_id": {
            "type": "string"
          }
        },
        "required": [
          "pronunciation_dictionary_id"
        ]
      }
    }
  },
  "required": [
    "provider",
    "model",
    "voice",
    "settings"
  ]
}
```

###### EnvironmentVoiceSettingsResponse

```json
{
  "type": "object",
  "properties": {
    "voice": {
      "$ref": "#/components/schemas/VersionSettingsVoice"
    }
  },
  "required": [
    "voice"
  ]
}
```

###### GladiaSTTLanguage

```json
{
  "type": "string",
  "enum": [
    "af",
    "am",
    "ar",
    "as",
    "az",
    "ba",
    "be",
    "bg",
    "bn",
    "bo",
    "br",
    "bs",
    "ca",
    "cs",
    "cy",
    "da",
    "de",
    "el",
    "en",
    "es",
    "et",
    "eu",
    "fa",
    "fi",
    "fo",
    "fr",
    "gl",
    "gu",
    "ha",
    "haw",
    "he",
    "hi",
    "hr",
    "ht",
    "hu",
    "hy",
    "id",
    "is",
    "it",
    "ja",
    "jw",
    "ka",
    "kk",
    "km",
    "kn",
    "ko",
    "la",
    "lb",
    "ln",
    "lo",
    "lt",
    "lv",
    "mg",
    "mi",
    "mk",
    "ml",
    "mn",
    "mr",
    "ms",
    "mt",
    "my",
    "ne",
    "nl",
    "nn",
    "no",
    "oc",
    "pa",
    "pl",
    "ps",
    "pt",
    "ro",
    "ru",
    "sa",
    "sd",
    "si",
    "sk",
    "sl",
    "sn",
    "so",
    "sq",
    "sr",
    "su",
    "sv",
    "sw",
    "ta",
    "te",
    "tg",
    "th",
    "tk",
    "tl",
    "tr",
    "tt",
    "uk",
    "ur",
    "uz",
    "vi",
    "yi",
    "yo",
    "zh"
  ],
  "x-enumNames": [
    "AFRIKAANS",
    "AMHARIC",
    "ARABIC",
    "ASSAMESE",
    "AZERBAIJANI",
    "BASHKIR",
    "BELARUSIAN",
    "BULGARIAN",
    "BENGALI",
    "TIBETAN",
    "BRETON",
    "BOSNIAN",
    "CATALAN",
    "CZECH",
    "WELSH",
    "DANISH",
    "GERMAN",
    "GREEK",
    "ENGLISH",
    "SPANISH",
    "ESTONIAN",
    "BASQUE",
    "PERSIAN",
    "FINNISH",
    "FAROESE",
    "FRENCH",
    "GALICIAN",
    "GUJARATI",
    "HAUSA",
    "HAWAIIAN",
    "HEBREW",
    "HINDI",
    "CROATIAN",
    "HAITIAN_CREOLE",
    "HUNGARIAN",
    "ARMENIAN",
    "INDONESIAN",
    "ICELANDIC",
    "ITALIAN",
    "JAPANESE",
    "JAVANESE",
    "GEORGIAN",
    "KAZAKH",
    "KHMER",
    "KANNADA",
    "KOREAN",
    "LATIN",
    "LUXEMBOURGISH",
    "LINGALA",
    "LAO",
    "LITHUANIAN",
    "LATVIAN",
    "MALAGASY",
    "MAORI",
    "MACEDONIAN",
    "MALAYALAM",
    "MONGOLIAN",
    "MARATHI",
    "MALAY",
    "MALTESE",
    "MYANMAR",
    "NEPALI",
    "DUTCH",
    "NORWEGIAN_NYNORSK",
    "NORWEGIAN",
    "OCCITAN",
    "PUNJABI",
    "POLISH",
    "PASHTO",
    "PORTUGUESE",
    "ROMANIAN",
    "RUSSIAN",
    "SANSKRIT",
    "SINDHI",
    "SINHALA",
    "SLOVAK",
    "SLOVENIAN",
    "SHONA",
    "SOMALI",
    "ALBANIAN",
    "SERBIAN",
    "SUNDANESE",
    "SWEDISH",
    "SWAHILI",
    "TAMIL",
    "TELUGU",
    "TAJIK",
    "THAI",
    "TURKMEN",
    "TAGALOG",
    "TURKISH",
    "TATAR",
    "UKRAINIAN",
    "URDU",
    "UZBEK",
    "VIETNAMESE",
    "YIDDISH",
    "YORUBA",
    "CHINESE"
  ]
}
```

###### GladiaSTTModel

```json
{
  "type": "string",
  "enum": [
    "solaria-1"
  ],
  "x-enumNames": [
    "SOLARIA_1"
  ]
}
```

###### GladiaSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "gladia"
      ],
      "x-enumNames": [
        "GLADIA"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/GladiaSTTModel"
    },
    "endpointing": {
      "type": "number"
    },
    "maxDurationWithoutEndpointing": {
      "type": "number"
    },
    "languages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GladiaSTTLanguage"
      }
    }
  },
  "required": [
    "provider",
    "model",
    "endpointing",
    "maxDurationWithoutEndpointing",
    "languages"
  ]
}
```

###### GoogleSTTLanguage

```json
{
  "type": "string",
  "enum": [
    "auto",
    "ca-ES",
    "cmn-Hans-CN",
    "hr-HR",
    "da-DK",
    "nl-NL",
    "en-AU",
    "en-GB",
    "en-IN",
    "en-US",
    "fi-FI",
    "fr-CA",
    "fr-FR",
    "de-DE",
    "el-GR",
    "hi-IN",
    "it-IT",
    "ja-JP",
    "ko-KR",
    "pl-PL",
    "pt-BR",
    "pt-PT",
    "ro-RO",
    "ru-RU",
    "es-ES",
    "es-US",
    "sv-SE",
    "tr-TR",
    "uk-UA",
    "vi-VN",
    "ar-XA",
    "ar-DZ",
    "ar-BH",
    "ar-EG",
    "ar-IL",
    "ar-JO",
    "ar-KW",
    "ar-LB",
    "ar-MR",
    "ar-MA",
    "ar-OM",
    "ar-QA",
    "ar-SA",
    "ar-PS",
    "ar-SY",
    "ar-TN",
    "ar-AE",
    "ar-YE",
    "hy-AM",
    "bn-BD",
    "bn-IN",
    "bg-BG",
    "my-MM",
    "ar-IQ",
    "yue-Hant-HK",
    "cmn-Hant-TW",
    "cs-CZ",
    "en-PH",
    "et-EE",
    "fil-PH",
    "gu-IN",
    "iw-IL",
    "hu-HU",
    "id-ID",
    "kn-IN",
    "km-KH",
    "lo-LA",
    "lv-LV",
    "lt-LT",
    "ms-MY",
    "ml-IN",
    "mr-IN",
    "ne-NP",
    "no-NO",
    "fa-IR",
    "pa-Guru-IN",
    "sr-RS",
    "sk-SK",
    "sl-SI",
    "es-MX",
    "sw",
    "ta-IN",
    "te-IN",
    "th-TH",
    "uz-UZ"
  ],
  "x-enumNames": [
    "AUTO",
    "CA_ES",
    "CMN_HANS_CN",
    "HR_HR",
    "DA_DK",
    "NL_NL",
    "EN_AU",
    "EN_GB",
    "EN_IN",
    "EN_US",
    "FI_FI",
    "FR_CA",
    "FR_FR",
    "DE_DE",
    "EL_GR",
    "HI_IN",
    "IT_IT",
    "JA_JP",
    "KO_KR",
    "PL_PL",
    "PT_BR",
    "PT_PT",
    "RO_RO",
    "RU_RU",
    "ES_ES",
    "ES_US",
    "SV_SE",
    "TR_TR",
    "UK_UA",
    "VI_VN",
    "AR_XA",
    "AR_DZ",
    "AR_BH",
    "AR_EG",
    "AR_IL",
    "AR_JO",
    "AR_KW",
    "AR_LB",
    "AR_MR",
    "AR_MA",
    "AR_OM",
    "AR_QA",
    "AR_SA",
    "AR_PS",
    "AR_SY",
    "AR_TN",
    "AR_AE",
    "AR_YE",
    "HY_AM",
    "BN_BD",
    "BN_IN",
    "BG_BG",
    "MY_MM",
    "AR_IQ",
    "YUE_HANT_HK",
    "CMN_HANT_TW",
    "CS_CZ",
    "EN_PH",
    "ET_EE",
    "FIL_PH",
    "GU_IN",
    "IW_IL",
    "HU_HU",
    "ID_ID",
    "KN_IN",
    "KM_KH",
    "LO_LA",
    "LV_LV",
    "LT_LT",
    "MS_MY",
    "ML_IN",
    "MR_IN",
    "NE_NP",
    "NO_NO",
    "FA_IR",
    "PA_GURU_IN",
    "SR_RS",
    "SK_SK",
    "SL_SI",
    "ES_MX",
    "SW",
    "TA_IN",
    "TE_IN",
    "TH_TH",
    "UZ_UZ"
  ]
}
```

###### GoogleSTTModel

```json
{
  "type": "string",
  "enum": [
    "chirp_3"
  ],
  "x-enumNames": [
    "CHIRP_3"
  ]
}
```

###### GoogleSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "google"
      ],
      "x-enumNames": [
        "GOOGLE"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/GoogleSTTModel"
    },
    "languages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GoogleSTTLanguage"
      }
    }
  },
  "required": [
    "provider",
    "model",
    "languages"
  ]
}
```

###### GoogleTTSModelID

```json
{
  "type": "string",
  "enum": [
    "standard",
    "wavenet",
    "neural2",
    "polyglot",
    "studio",
    "Chirp3-HD",
    "gemini-2.5-flash"
  ],
  "x-enumNames": [
    "STANDARD",
    "WAVENET",
    "NEURAL_2",
    "POLYGLOT",
    "STUDIO",
    "CHIRP_3_HD",
    "GEMINI_2_5_FLASH"
  ]
}
```

###### GoogleVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "google"
      ],
      "x-enumNames": [
        "GOOGLE"
      ]
    },
    "model": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GoogleTTSModelID"
        }
      ]
    },
    "languageCode": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "settings": {
      "type": "object",
      "properties": {
        "prompt": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

###### MicrosoftVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "microsoft"
      ],
      "x-enumNames": [
        "MICROSOFT"
      ]
    },
    "voice": {
      "type": "string"
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

###### PronunciationDictionaryEntry

```json
{
  "type": "object",
  "properties": {
    "from": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "to": {
      "type": "string",
      "maxLength": 128
    }
  },
  "required": [
    "from",
    "to"
  ]
}
```

###### RimelabsVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "rimelabs"
      ],
      "x-enumNames": [
        "RIMELABS"
      ]
    },
    "model": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "language": {
      "type": "string"
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

###### STTSettings

```json
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/ElevenLabsSTTSettings"
    },
    {
      "$ref": "#/components/schemas/DeepgramSTTSettings"
    },
    {
      "$ref": "#/components/schemas/AssemblyAISTTSettings"
    },
    {
      "$ref": "#/components/schemas/CartesiaSTTSettings"
    },
    {
      "$ref": "#/components/schemas/GladiaSTTSettings"
    },
    {
      "$ref": "#/components/schemas/GoogleSTTSettings"
    },
    {
      "$ref": "#/components/schemas/SonioxSTTSettings"
    }
  ]
}
```

###### SonioxSTTLanguage

```json
{
  "type": "string",
  "enum": [
    "auto",
    "af",
    "sq",
    "ar",
    "az",
    "eu",
    "be",
    "bn",
    "bs",
    "bg",
    "ca",
    "zh",
    "hr",
    "cs",
    "da",
    "nl",
    "en",
    "et",
    "fi",
    "fr",
    "gl",
    "de",
    "el",
    "gu",
    "he",
    "hi",
    "hu",
    "id",
    "it",
    "ja",
    "kn",
    "kk",
    "ko",
    "lv",
    "lt",
    "mk",
    "ms",
    "ml",
    "mr",
    "no",
    "fa",
    "pl",
    "pt",
    "pa",
    "ro",
    "ru",
    "sr",
    "sk",
    "sl",
    "es",
    "sw",
    "sv",
    "tl",
    "ta",
    "te",
    "th",
    "tr",
    "uk",
    "ur",
    "vi",
    "cy"
  ],
  "x-enumNames": [
    "AUTO",
    "AFRIKAANS",
    "ALBANIAN",
    "ARABIC",
    "AZERBAIJANI",
    "BASQUE",
    "BELARUSIAN",
    "BENGALI",
    "BOSNIAN",
    "BULGARIAN",
    "CATALAN",
    "CHINESE",
    "CROATIAN",
    "CZECH",
    "DANISH",
    "DUTCH",
    "ENGLISH",
    "ESTONIAN",
    "FINNISH",
    "FRENCH",
    "GALICIAN",
    "GERMAN",
    "GREEK",
    "GUJARATI",
    "HEBREW",
    "HINDI",
    "HUNGARIAN",
    "INDONESIAN",
    "ITALIAN",
    "JAPANESE",
    "KANNADA",
    "KAZAKH",
    "KOREAN",
    "LATVIAN",
    "LITHUANIAN",
    "MACEDONIAN",
    "MALAY",
    "MALAYALAM",
    "MARATHI",
    "NORWEGIAN",
    "PERSIAN",
    "POLISH",
    "PORTUGUESE",
    "PUNJABI",
    "ROMANIAN",
    "RUSSIAN",
    "SERBIAN",
    "SLOVAK",
    "SLOVENIAN",
    "SPANISH",
    "SWAHILI",
    "SWEDISH",
    "TAGALOG",
    "TAMIL",
    "TELUGU",
    "THAI",
    "TURKISH",
    "UKRAINIAN",
    "URDU",
    "VIETNAMESE",
    "WELSH"
  ]
}
```

###### SonioxSTTModel

```json
{
  "type": "string",
  "enum": [
    "stt-rt-v5"
  ],
  "x-enumNames": [
    "STT_RT_V_5"
  ]
}
```

###### SonioxSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "soniox"
      ],
      "x-enumNames": [
        "SONIOX"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/SonioxSTTModel"
    },
    "maxEndpointDelayMS": {
      "type": "integer",
      "minimum": 500,
      "maximum": 3000
    },
    "endpointSensitivity": {
      "type": "number",
      "minimum": -1,
      "maximum": 1
    },
    "keyterms": {
      "type": "string"
    },
    "languages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SonioxSTTLanguage"
      }
    }
  },
  "required": [
    "provider",
    "model",
    "languages"
  ]
}
```

###### SonioxVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "soniox"
      ],
      "x-enumNames": [
        "SONIOX"
      ]
    },
    "model": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "language": {
      "type": "string"
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

###### VersionSettingsVoice

```json
{
  "type": "object",
  "properties": {
    "stt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/STTSettings"
        }
      ]
    },
    "tts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VoiceSettings"
        }
      ]
    },
    "pronunciationDictionary": {
      "maxItems": 500,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PronunciationDictionaryEntry"
      }
    },
    "failureMessage": {
      "nullable": true,
      "type": "string"
    },
    "hasCallRecording": {
      "default": true,
      "type": "boolean"
    },
    "audioCue": {
      "nullable": true,
      "type": "number"
    },
    "backgroundAudio": {
      "nullable": true,
      "type": "string"
    },
    "backgroundAudioSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BackgroundAudioSettings"
        }
      ]
    },
    "audioSync": {
      "type": "boolean"
    },
    "keypadInput": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VoiceKeypadSettings"
        }
      ]
    },
    "silenceTimeoutMs": {
      "type": "number"
    },
    "maxDuration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VoiceMaxDurationSettings"
        }
      ]
    },
    "callerIdentity": {
      "type": "string",
      "enum": [
        "phone-number",
        "call"
      ],
      "description": "phone-number retains variables for returning callers; call uses a new runtime identity for each call. An omitted setting preserves phone-number behavior."
    },
    "localeOverrides": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/VoiceLocaleOverride"
      },
      "description": "Replaces tts when the conversation locale matches an override."
    },
    "hasProviderCallRecording": {
      "type": "boolean"
    }
  }
}
```

###### VoiceKeypadSettings

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "delimiter": {
      "maxItems": 2,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DTMFDelimiter"
      }
    },
    "timeoutInSeconds": {
      "type": "number"
    }
  },
  "required": [
    "enabled",
    "delimiter",
    "timeoutInSeconds"
  ]
}
```

###### VoiceLocaleOverride

```json
{
  "type": "object",
  "properties": {
    "locale": {
      "type": "string",
      "minLength": 1,
      "description": "A language such as fr or a regional locale such as fr-FR."
    },
    "tts": {
      "$ref": "#/components/schemas/VoiceSettings"
    }
  },
  "required": [
    "locale",
    "tts"
  ]
}
```

###### VoiceMaxDurationSettings

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "seconds": {
      "nullable": true,
      "type": "number"
    },
    "message": {
      "nullable": true,
      "type": "string"
    }
  },
  "required": [
    "enabled",
    "seconds",
    "message"
  ]
}
```

###### VoiceSettings

```json
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/AmazonVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/GoogleVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/CartesiaVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/RimelabsVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/SonioxVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/MicrosoftVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/ElevenLabsVoiceSettings"
    }
  ]
}
```

### Update Voice settings

#### Update environment voice settings

Update Voice settings on the selected Environment. Requires project:UPDATE. Top-level settings are merged; nested objects other than keypadInput are replaced when supplied. Read the existing value before changing part of stt, tts or maxDuration. Returns no response body.

##### Endpoint

```http
PATCH /v1alpha1/environment/{environmentID}/settings/voice
```

Server: https://realtime-api.voiceflow.com

##### Authentication

```json
[
  {
    "auth": []
  }
]
```

`auth`:

```json
{
  "type": "apiKey",
  "in": "header",
  "name": "authorization",
  "description": "Voiceflow API key"
}
```

##### Path parameters

###### `environmentID`

Required · string

```json
{
  "type": "string"
}
```

##### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/EnvironmentPatchVoiceSettingsRequest"
      }
    }
  }
}
```

##### Responses

###### 204

###### 400

Body does not match the Voice settings schema. Unknown top-level fields are rejected.

###### 401

Missing or invalid authentication.

###### 403

API key lacks the required project permission.

###### 404

Environment not found, or Environment has no Voice settings.

##### Request examples

###### cURL

```bash
curl --request PATCH \
  --url 'https://realtime-api.voiceflow.com/v1alpha1/environment/<environmentID>/settings/voice' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "stt": {
    "provider": "elevenlabs",
    "model": "<ElevenLabsSTTModel>",
    "language": "<ElevenLabsSTTLanguage>",
    "commitStrategy": "vad",
    "vadSilenceThresholdSecs": 0,
    "vadThreshold": 0,
    "minSpeechDurationMS": 0,
    "minSilenceDurationMS": 0
  },
  "tts": {
    "provider": "amazon",
    "voice": "<string>"
  },
  "pronunciationDictionary": [
    {
      "from": "<string>",
      "to": "<string>"
    }
  ],
  "failureMessage": "<string>",
  "hasCallRecording": true,
  "audioCue": 0,
  "backgroundAudio": "<string>",
  "backgroundAudioSettings": {
    "volume": 0.75
  },
  "audioSync": true,
  "keypadInput": {
    "enabled": true,
    "delimiter": [
      "<DTMFDelimiter>"
    ],
    "timeoutInSeconds": 0
  },
  "silenceTimeoutMs": 0,
  "maxDuration": {
    "enabled": true,
    "seconds": 0,
    "message": "<string>"
  },
  "callerIdentity": "phone-number",
  "localeOverrides": [
    {
      "locale": "<string>",
      "tts": "<AmazonVoiceSettings>"
    }
  ],
  "hasProviderCallRecording": true
}'
```

###### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1alpha1/environment/<environmentID>/settings/voice', {
  method: 'PATCH',
  headers: {
    Authorization: '<api-key>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "stt": {
      "provider": "elevenlabs",
      "model": "<ElevenLabsSTTModel>",
      "language": "<ElevenLabsSTTLanguage>",
      "commitStrategy": "vad",
      "vadSilenceThresholdSecs": 0,
      "vadThreshold": 0,
      "minSpeechDurationMS": 0,
      "minSilenceDurationMS": 0
    },
    "tts": {
      "provider": "amazon",
      "voice": "<string>"
    },
    "pronunciationDictionary": [
      {
        "from": "<string>",
        "to": "<string>"
      }
    ],
    "failureMessage": "<string>",
    "hasCallRecording": true,
    "audioCue": 0,
    "backgroundAudio": "<string>",
    "backgroundAudioSettings": {
      "volume": 0.75
    },
    "audioSync": true,
    "keypadInput": {
      "enabled": true,
      "delimiter": [
        "<DTMFDelimiter>"
      ],
      "timeoutInSeconds": 0
    },
    "silenceTimeoutMs": 0,
    "maxDuration": {
      "enabled": true,
      "seconds": 0,
      "message": "<string>"
    },
    "callerIdentity": "phone-number",
    "localeOverrides": [
      {
        "locale": "<string>",
        "tts": "<AmazonVoiceSettings>"
      }
    ],
    "hasProviderCallRecording": true
  }),
});
// This operation returns no response body.
console.log(response.status);
```

###### Python

```python
import requests

response = requests.patch(
    'https://realtime-api.voiceflow.com/v1alpha1/environment/<environmentID>/settings/voice',
    headers={'Authorization': '<api-key>'},
    json={
      "stt": {
        "provider": "elevenlabs",
        "model": "<ElevenLabsSTTModel>",
        "language": "<ElevenLabsSTTLanguage>",
        "commitStrategy": "vad",
        "vadSilenceThresholdSecs": 0,
        "vadThreshold": 0,
        "minSpeechDurationMS": 0,
        "minSilenceDurationMS": 0
      },
      "tts": {
        "provider": "amazon",
        "voice": "<string>"
      },
      "pronunciationDictionary": [
        {
          "from": "<string>",
          "to": "<string>"
        }
      ],
      "failureMessage": "<string>",
      "hasCallRecording": True,
      "audioCue": 0,
      "backgroundAudio": "<string>",
      "backgroundAudioSettings": {
        "volume": 0.75
      },
      "audioSync": True,
      "keypadInput": {
        "enabled": True,
        "delimiter": [
          "<DTMFDelimiter>"
        ],
        "timeoutInSeconds": 0
      },
      "silenceTimeoutMs": 0,
      "maxDuration": {
        "enabled": True,
        "seconds": 0,
        "message": "<string>"
      },
      "callerIdentity": "phone-number",
      "localeOverrides": [
        {
          "locale": "<string>",
          "tts": "<AmazonVoiceSettings>"
        }
      ],
      "hasProviderCallRecording": True
    },
)
response.raise_for_status()
# This operation returns no response body.
```

##### Schema definitions

###### AmazonVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "amazon"
      ],
      "x-enumNames": [
        "AMAZON"
      ]
    },
    "voice": {
      "type": "string"
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

###### AssemblyAISTTLanguage

```json
{
  "type": "string",
  "enum": [
    "multi",
    "en",
    "ar",
    "da",
    "nl",
    "fi",
    "fr",
    "de",
    "he",
    "hi",
    "it",
    "ja",
    "zh",
    "no",
    "pt",
    "es",
    "sv",
    "tr",
    "vi"
  ],
  "x-enumNames": [
    "MULTI",
    "ENGLISH",
    "ARABIC",
    "DANISH",
    "DUTCH",
    "FINNISH",
    "FRENCH",
    "GERMAN",
    "HEBREW",
    "HINDI",
    "ITALIAN",
    "JAPANESE",
    "MANDARIN",
    "NORWEGIAN",
    "PORTUGUESE",
    "SPANISH",
    "SWEDISH",
    "TURKISH",
    "VIETNAMESE"
  ]
}
```

###### AssemblyAISTTMode

```json
{
  "type": "string",
  "enum": [
    "min_latency",
    "balanced",
    "max_accuracy"
  ],
  "x-enumNames": [
    "MIN_LATENCY",
    "BALANCED",
    "MAX_ACCURACY"
  ]
}
```

###### AssemblyAISTTModel

```json
{
  "type": "string",
  "enum": [
    "universal-streaming-english",
    "universal-3-5-pro"
  ],
  "x-enumNames": [
    "UNIVERSAL_STREAMING_ENGLISH",
    "UNIVERSAL_3_5_PRO"
  ]
}
```

###### AssemblyAISTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "assemblyai"
      ],
      "x-enumNames": [
        "ASSEMBLYAI"
      ]
    },
    "model": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssemblyAISTTModel"
        }
      ]
    },
    "mode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssemblyAISTTMode"
        }
      ]
    },
    "language": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssemblyAISTTLanguage"
        }
      ]
    },
    "keyterms": {
      "type": "string"
    },
    "confidenceThreshold": {
      "default": 0.7,
      "type": "number"
    },
    "maxTurnSilence": {
      "default": 2400,
      "type": "number"
    },
    "minTurnSilence": {
      "default": 160,
      "type": "number"
    }
  },
  "required": [
    "provider"
  ]
}
```

###### BackgroundAudioSettings

```json
{
  "type": "object",
  "properties": {
    "volume": {
      "default": 0.75,
      "type": "number",
      "minimum": 0,
      "maximum": 1
    }
  }
}
```

###### CartesiaSTTLanguage

```json
{
  "type": "string",
  "enum": [
    "en",
    "af",
    "ar",
    "hy",
    "az",
    "be",
    "bs",
    "bg",
    "ca",
    "zh",
    "hr",
    "cs",
    "da",
    "nl",
    "et",
    "fi",
    "fr",
    "gl",
    "de",
    "el",
    "he",
    "hi",
    "hu",
    "is",
    "id",
    "it",
    "ja",
    "kn",
    "kk",
    "ko",
    "lv",
    "lt",
    "mk",
    "ms",
    "mr",
    "mi",
    "ne",
    "no",
    "fa",
    "pl",
    "pt",
    "ro",
    "ru",
    "sr",
    "sk",
    "sl",
    "es",
    "sw",
    "sv",
    "tl",
    "ta",
    "th",
    "tr",
    "uk",
    "ur",
    "vi",
    "cy"
  ],
  "x-enumNames": [
    "ENGLISH",
    "AFRIKAANS",
    "ARABIC",
    "ARMENIAN",
    "AZERBAIJANI",
    "BELARUSIAN",
    "BOSNIAN",
    "BULGARIAN",
    "CATALAN",
    "CHINESE",
    "CROATIAN",
    "CZECH",
    "DANISH",
    "DUTCH",
    "ESTONIAN",
    "FINNISH",
    "FRENCH",
    "GALICIAN",
    "GERMAN",
    "GREEK",
    "HEBREW",
    "HINDI",
    "HUNGARIAN",
    "ICELANDIC",
    "INDONESIAN",
    "ITALIAN",
    "JAPANESE",
    "KANNADA",
    "KAZAKH",
    "KOREAN",
    "LATVIAN",
    "LITHUANIAN",
    "MACEDONIAN",
    "MALAY",
    "MARATHI",
    "MAORI",
    "NEPALI",
    "NORWEGIAN",
    "PERSIAN",
    "POLISH",
    "PORTUGUESE",
    "ROMANIAN",
    "RUSSIAN",
    "SERBIAN",
    "SLOVAK",
    "SLOVENIAN",
    "SPANISH",
    "SWAHILI",
    "SWEDISH",
    "TAGALOG",
    "TAMIL",
    "THAI",
    "TURKISH",
    "UKRAINIAN",
    "URDU",
    "VIETNAMESE",
    "WELSH"
  ]
}
```

###### CartesiaSTTModel

```json
{
  "type": "string",
  "enum": [
    "ink-whisper",
    "ink-2"
  ],
  "x-enumNames": [
    "INK_WHISPER",
    "INK_2"
  ]
}
```

###### CartesiaSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "cartesia"
      ],
      "x-enumNames": [
        "CARTESIA"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/CartesiaSTTModel"
    },
    "language": {
      "$ref": "#/components/schemas/CartesiaSTTLanguage"
    }
  },
  "required": [
    "provider",
    "model",
    "language"
  ]
}
```

###### CartesiaVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "cartesia"
      ],
      "x-enumNames": [
        "CARTESIA"
      ]
    },
    "model": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "settings": {
      "type": "object",
      "properties": {
        "speed": {
          "type": "number",
          "minimum": 0.6,
          "maximum": 1.5
        }
      }
    }
  },
  "required": [
    "provider",
    "model",
    "voice"
  ]
}
```

###### DTMFDelimiter

```json
{
  "type": "string",
  "enum": [
    "#",
    "*"
  ],
  "x-enumNames": [
    "#",
    "*"
  ]
}
```

###### DeepgramSTTLanguage

```json
{
  "type": "string",
  "enum": [
    "multi",
    "ar",
    "ar-AE",
    "ar-DZ",
    "ar-EG",
    "ar-IQ",
    "ar-IR",
    "ar-JO",
    "ar-KW",
    "ar-LB",
    "ar-MA",
    "ar-PS",
    "ar-QA",
    "ar-SA",
    "ar-SD",
    "ar-SY",
    "ar-TD",
    "ar-TN",
    "be",
    "bg",
    "bn",
    "bs",
    "ca",
    "cs",
    "da",
    "da-DK",
    "de",
    "de-CH",
    "el",
    "en",
    "en-AU",
    "en-GB",
    "en-IN",
    "en-NZ",
    "en-US",
    "es",
    "es-419",
    "et",
    "fa",
    "fi",
    "fr",
    "fr-CA",
    "he",
    "hi",
    "hr",
    "hu",
    "id",
    "it",
    "ja",
    "kn",
    "ko",
    "ko-KR",
    "lt",
    "lv",
    "mk",
    "mr",
    "ms",
    "nl",
    "nl-BE",
    "no",
    "pl",
    "pt",
    "pt-BR",
    "pt-PT",
    "ro",
    "ru",
    "sk",
    "sl",
    "sr",
    "sv",
    "sv-SE",
    "ta",
    "te",
    "th",
    "tl",
    "tr",
    "uk",
    "ur",
    "vi",
    "zh",
    "zh-HK",
    "zh-TW"
  ],
  "x-enumNames": [
    "MULTI",
    "AR",
    "AR_AE",
    "AR_DZ",
    "AR_EG",
    "AR_IQ",
    "AR_IR",
    "AR_JO",
    "AR_KW",
    "AR_LB",
    "AR_MA",
    "AR_PS",
    "AR_QA",
    "AR_SA",
    "AR_SD",
    "AR_SY",
    "AR_TD",
    "AR_TN",
    "BE",
    "BG",
    "BN",
    "BS",
    "CA",
    "CS",
    "DA",
    "DA_DK",
    "DE",
    "DE_CH",
    "EL",
    "EN",
    "EN_AU",
    "EN_GB",
    "EN_IN",
    "EN_NZ",
    "EN_US",
    "ES",
    "ES_419",
    "ET",
    "FA",
    "FI",
    "FR",
    "FR_CA",
    "HE",
    "HI",
    "HR",
    "HU",
    "ID",
    "IT",
    "JA",
    "KN",
    "KO",
    "KO_KR",
    "LT",
    "LV",
    "MK",
    "MR",
    "MS",
    "NL",
    "NL_BE",
    "NO",
    "PL",
    "PT",
    "PT_BR",
    "PT_PT",
    "RO",
    "RU",
    "SK",
    "SL",
    "SR",
    "SV",
    "SV_SE",
    "TA",
    "TE",
    "TH",
    "TL",
    "TR",
    "UK",
    "UR",
    "VI",
    "ZH",
    "ZH_HK",
    "ZH_TW"
  ]
}
```

###### DeepgramSTTModel

```json
{
  "type": "string",
  "enum": [
    "nova-2",
    "nova-3",
    "nova-3-medical",
    "flux"
  ],
  "x-enumNames": [
    "NOVA_2",
    "NOVA_3",
    "NOVA_3_MEDICAL",
    "FLUX"
  ]
}
```

###### DeepgramSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "deepgram"
      ],
      "x-enumNames": [
        "DEEPGRAM"
      ]
    },
    "model": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeepgramSTTModel"
        }
      ]
    },
    "locale": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeepgramSTTLanguage"
        }
      ]
    },
    "keywords": {
      "type": "string"
    },
    "partialWaitMS": {
      "type": "number"
    },
    "silenceWaitMS": {
      "type": "number"
    },
    "punctuationWaitMS": {
      "type": "number"
    },
    "interruptionWaitWords": {
      "type": "number"
    },
    "EOTTimeout": {
      "type": "number"
    },
    "EOTThreshold": {
      "type": "number"
    },
    "languageHints": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DeepgramSTTLanguage"
      }
    }
  },
  "required": [
    "provider"
  ]
}
```

###### ElevenLabsSTTLanguage

```json
{
  "type": "string",
  "enum": [
    "afr",
    "amh",
    "ara",
    "hye",
    "asm",
    "ast",
    "aze",
    "bel",
    "ben",
    "bos",
    "bul",
    "mya",
    "yue",
    "cat",
    "ceb",
    "nya",
    "hrv",
    "ces",
    "dan",
    "nld",
    "eng",
    "est",
    "fil",
    "fin",
    "fra",
    "ful",
    "glg",
    "lug",
    "kat",
    "deu",
    "ell",
    "guj",
    "hau",
    "heb",
    "hin",
    "hun",
    "isl",
    "ibo",
    "ind",
    "gle",
    "ita",
    "jpn",
    "jav",
    "kea",
    "kan",
    "kaz",
    "khm",
    "kor",
    "kur",
    "kir",
    "lao",
    "lav",
    "lin",
    "lit",
    "luo",
    "ltz",
    "mkd",
    "msa",
    "mal",
    "mlt",
    "zho",
    "mri",
    "mar",
    "mon",
    "nep",
    "nso",
    "nor",
    "oci",
    "ori",
    "pus",
    "fas",
    "pol",
    "por",
    "pan",
    "ron",
    "rus",
    "srp",
    "sna",
    "snd",
    "slk",
    "slv",
    "som",
    "spa",
    "swa",
    "swe",
    "tam",
    "tgk",
    "tel",
    "tha",
    "tur",
    "ukr",
    "umb",
    "urd",
    "uzb",
    "vie",
    "cym",
    "wol",
    "xho",
    "zul"
  ],
  "x-enumNames": [
    "AFRIKAANS",
    "AMHARIC",
    "ARABIC",
    "ARMENIAN",
    "ASSAMESE",
    "ASTURIAN",
    "AZERBAIJANI",
    "BELARUSIAN",
    "BENGALI",
    "BOSNIAN",
    "BULGARIAN",
    "BURMESE",
    "CANTONESE",
    "CATALAN",
    "CEBUANO",
    "CHICHEWA",
    "CROATIAN",
    "CZECH",
    "DANISH",
    "DUTCH",
    "ENGLISH",
    "ESTONIAN",
    "FILIPINO",
    "FINNISH",
    "FRENCH",
    "FULAH",
    "GALICIAN",
    "GANDA",
    "GEORGIAN",
    "GERMAN",
    "GREEK",
    "GUJARATI",
    "HAUSA",
    "HEBREW",
    "HINDI",
    "HUNGARIAN",
    "ICELANDIC",
    "IGBO",
    "INDONESIAN",
    "IRISH",
    "ITALIAN",
    "JAPANESE",
    "JAVANESE",
    "KABUVERDIANU",
    "KANNADA",
    "KAZAKH",
    "KHMER",
    "KOREAN",
    "KURDISH",
    "KYRGYZ",
    "LAO",
    "LATVIAN",
    "LINGALA",
    "LITHUANIAN",
    "LUO",
    "LUXEMBOURGISH",
    "MACEDONIAN",
    "MALAY",
    "MALAYALAM",
    "MALTESE",
    "MANDARIN_CHINESE",
    "MAORI",
    "MARATHI",
    "MONGOLIAN",
    "NEPALI",
    "NORTHERN_SOTHO",
    "NORWEGIAN",
    "OCCITAN",
    "ODIA",
    "PASHTO",
    "PERSIAN",
    "POLISH",
    "PORTUGUESE",
    "PUNJABI",
    "ROMANIAN",
    "RUSSIAN",
    "SERBIAN",
    "SHONA",
    "SINDHI",
    "SLOVAK",
    "SLOVENIAN",
    "SOMALI",
    "SPANISH",
    "SWAHILI",
    "SWEDISH",
    "TAMIL",
    "TAJIK",
    "TELUGU",
    "THAI",
    "TURKISH",
    "UKRAINIAN",
    "UMBUNDU",
    "URDU",
    "UZBEK",
    "VIETNAMESE",
    "WELSH",
    "WOLOF",
    "XHOSA",
    "ZULU"
  ]
}
```

###### ElevenLabsSTTModel

```json
{
  "type": "string",
  "enum": [
    "scribe_v2_realtime"
  ],
  "x-enumNames": [
    "SCRIBE_V_2_REALTIME"
  ]
}
```

###### ElevenLabsSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "elevenlabs"
      ],
      "x-enumNames": [
        "ELEVENLABS"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/ElevenLabsSTTModel"
    },
    "language": {
      "$ref": "#/components/schemas/ElevenLabsSTTLanguage"
    },
    "commitStrategy": {
      "type": "string",
      "enum": [
        "vad",
        "manual"
      ],
      "x-enumNames": [
        "VAD",
        "MANUAL"
      ]
    },
    "vadSilenceThresholdSecs": {
      "type": "number",
      "minimum": 0.3,
      "maximum": 3
    },
    "vadThreshold": {
      "type": "number",
      "minimum": 0.1,
      "maximum": 0.9
    },
    "minSpeechDurationMS": {
      "type": "number",
      "minimum": 50,
      "maximum": 2000
    },
    "minSilenceDurationMS": {
      "type": "number",
      "minimum": 50,
      "maximum": 2000
    }
  },
  "required": [
    "provider",
    "model",
    "language"
  ]
}
```

###### ElevenLabsVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "elevenlabs"
      ],
      "x-enumNames": [
        "ELEVENLABS"
      ]
    },
    "model": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "useCustomVoice": {
      "type": "boolean"
    },
    "settings": {
      "type": "object",
      "properties": {
        "speed": {
          "type": "number",
          "minimum": 0.7,
          "maximum": 1.3
        },
        "style": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "stability": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "speaker_boost": {
          "type": "boolean"
        },
        "similarity_boost": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        }
      }
    },
    "pronunciation_dictionaries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "pronunciation_dictionary_id": {
            "type": "string"
          },
          "version_id": {
            "type": "string"
          }
        },
        "required": [
          "pronunciation_dictionary_id"
        ]
      }
    }
  },
  "required": [
    "provider",
    "model",
    "voice",
    "settings"
  ]
}
```

###### EnvironmentPatchVoiceSettingsRequest

```json
{
  "type": "object",
  "properties": {
    "stt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/STTSettings"
        }
      ]
    },
    "tts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VoiceSettings"
        }
      ]
    },
    "pronunciationDictionary": {
      "maxItems": 500,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PronunciationDictionaryEntry"
      }
    },
    "failureMessage": {
      "nullable": true,
      "type": "string"
    },
    "hasCallRecording": {
      "type": "boolean"
    },
    "audioCue": {
      "nullable": true,
      "type": "number"
    },
    "backgroundAudio": {
      "nullable": true,
      "type": "string"
    },
    "backgroundAudioSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BackgroundAudioSettings"
        }
      ]
    },
    "audioSync": {
      "type": "boolean"
    },
    "keypadInput": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VoiceKeypadSettings"
        }
      ]
    },
    "silenceTimeoutMs": {
      "type": "number"
    },
    "maxDuration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VoiceMaxDurationSettings"
        }
      ]
    },
    "callerIdentity": {
      "type": "string",
      "enum": [
        "phone-number",
        "call"
      ],
      "description": "phone-number retains variables for returning callers; call uses a new runtime identity for each call. An omitted setting preserves phone-number behavior."
    },
    "localeOverrides": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/VoiceLocaleOverride"
      },
      "description": "Replaces tts when the conversation locale matches an override."
    },
    "hasProviderCallRecording": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}
```

###### GladiaSTTLanguage

```json
{
  "type": "string",
  "enum": [
    "af",
    "am",
    "ar",
    "as",
    "az",
    "ba",
    "be",
    "bg",
    "bn",
    "bo",
    "br",
    "bs",
    "ca",
    "cs",
    "cy",
    "da",
    "de",
    "el",
    "en",
    "es",
    "et",
    "eu",
    "fa",
    "fi",
    "fo",
    "fr",
    "gl",
    "gu",
    "ha",
    "haw",
    "he",
    "hi",
    "hr",
    "ht",
    "hu",
    "hy",
    "id",
    "is",
    "it",
    "ja",
    "jw",
    "ka",
    "kk",
    "km",
    "kn",
    "ko",
    "la",
    "lb",
    "ln",
    "lo",
    "lt",
    "lv",
    "mg",
    "mi",
    "mk",
    "ml",
    "mn",
    "mr",
    "ms",
    "mt",
    "my",
    "ne",
    "nl",
    "nn",
    "no",
    "oc",
    "pa",
    "pl",
    "ps",
    "pt",
    "ro",
    "ru",
    "sa",
    "sd",
    "si",
    "sk",
    "sl",
    "sn",
    "so",
    "sq",
    "sr",
    "su",
    "sv",
    "sw",
    "ta",
    "te",
    "tg",
    "th",
    "tk",
    "tl",
    "tr",
    "tt",
    "uk",
    "ur",
    "uz",
    "vi",
    "yi",
    "yo",
    "zh"
  ],
  "x-enumNames": [
    "AFRIKAANS",
    "AMHARIC",
    "ARABIC",
    "ASSAMESE",
    "AZERBAIJANI",
    "BASHKIR",
    "BELARUSIAN",
    "BULGARIAN",
    "BENGALI",
    "TIBETAN",
    "BRETON",
    "BOSNIAN",
    "CATALAN",
    "CZECH",
    "WELSH",
    "DANISH",
    "GERMAN",
    "GREEK",
    "ENGLISH",
    "SPANISH",
    "ESTONIAN",
    "BASQUE",
    "PERSIAN",
    "FINNISH",
    "FAROESE",
    "FRENCH",
    "GALICIAN",
    "GUJARATI",
    "HAUSA",
    "HAWAIIAN",
    "HEBREW",
    "HINDI",
    "CROATIAN",
    "HAITIAN_CREOLE",
    "HUNGARIAN",
    "ARMENIAN",
    "INDONESIAN",
    "ICELANDIC",
    "ITALIAN",
    "JAPANESE",
    "JAVANESE",
    "GEORGIAN",
    "KAZAKH",
    "KHMER",
    "KANNADA",
    "KOREAN",
    "LATIN",
    "LUXEMBOURGISH",
    "LINGALA",
    "LAO",
    "LITHUANIAN",
    "LATVIAN",
    "MALAGASY",
    "MAORI",
    "MACEDONIAN",
    "MALAYALAM",
    "MONGOLIAN",
    "MARATHI",
    "MALAY",
    "MALTESE",
    "MYANMAR",
    "NEPALI",
    "DUTCH",
    "NORWEGIAN_NYNORSK",
    "NORWEGIAN",
    "OCCITAN",
    "PUNJABI",
    "POLISH",
    "PASHTO",
    "PORTUGUESE",
    "ROMANIAN",
    "RUSSIAN",
    "SANSKRIT",
    "SINDHI",
    "SINHALA",
    "SLOVAK",
    "SLOVENIAN",
    "SHONA",
    "SOMALI",
    "ALBANIAN",
    "SERBIAN",
    "SUNDANESE",
    "SWEDISH",
    "SWAHILI",
    "TAMIL",
    "TELUGU",
    "TAJIK",
    "THAI",
    "TURKMEN",
    "TAGALOG",
    "TURKISH",
    "TATAR",
    "UKRAINIAN",
    "URDU",
    "UZBEK",
    "VIETNAMESE",
    "YIDDISH",
    "YORUBA",
    "CHINESE"
  ]
}
```

###### GladiaSTTModel

```json
{
  "type": "string",
  "enum": [
    "solaria-1"
  ],
  "x-enumNames": [
    "SOLARIA_1"
  ]
}
```

###### GladiaSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "gladia"
      ],
      "x-enumNames": [
        "GLADIA"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/GladiaSTTModel"
    },
    "endpointing": {
      "type": "number"
    },
    "maxDurationWithoutEndpointing": {
      "type": "number"
    },
    "languages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GladiaSTTLanguage"
      }
    }
  },
  "required": [
    "provider",
    "model",
    "endpointing",
    "maxDurationWithoutEndpointing",
    "languages"
  ]
}
```

###### GoogleSTTLanguage

```json
{
  "type": "string",
  "enum": [
    "auto",
    "ca-ES",
    "cmn-Hans-CN",
    "hr-HR",
    "da-DK",
    "nl-NL",
    "en-AU",
    "en-GB",
    "en-IN",
    "en-US",
    "fi-FI",
    "fr-CA",
    "fr-FR",
    "de-DE",
    "el-GR",
    "hi-IN",
    "it-IT",
    "ja-JP",
    "ko-KR",
    "pl-PL",
    "pt-BR",
    "pt-PT",
    "ro-RO",
    "ru-RU",
    "es-ES",
    "es-US",
    "sv-SE",
    "tr-TR",
    "uk-UA",
    "vi-VN",
    "ar-XA",
    "ar-DZ",
    "ar-BH",
    "ar-EG",
    "ar-IL",
    "ar-JO",
    "ar-KW",
    "ar-LB",
    "ar-MR",
    "ar-MA",
    "ar-OM",
    "ar-QA",
    "ar-SA",
    "ar-PS",
    "ar-SY",
    "ar-TN",
    "ar-AE",
    "ar-YE",
    "hy-AM",
    "bn-BD",
    "bn-IN",
    "bg-BG",
    "my-MM",
    "ar-IQ",
    "yue-Hant-HK",
    "cmn-Hant-TW",
    "cs-CZ",
    "en-PH",
    "et-EE",
    "fil-PH",
    "gu-IN",
    "iw-IL",
    "hu-HU",
    "id-ID",
    "kn-IN",
    "km-KH",
    "lo-LA",
    "lv-LV",
    "lt-LT",
    "ms-MY",
    "ml-IN",
    "mr-IN",
    "ne-NP",
    "no-NO",
    "fa-IR",
    "pa-Guru-IN",
    "sr-RS",
    "sk-SK",
    "sl-SI",
    "es-MX",
    "sw",
    "ta-IN",
    "te-IN",
    "th-TH",
    "uz-UZ"
  ],
  "x-enumNames": [
    "AUTO",
    "CA_ES",
    "CMN_HANS_CN",
    "HR_HR",
    "DA_DK",
    "NL_NL",
    "EN_AU",
    "EN_GB",
    "EN_IN",
    "EN_US",
    "FI_FI",
    "FR_CA",
    "FR_FR",
    "DE_DE",
    "EL_GR",
    "HI_IN",
    "IT_IT",
    "JA_JP",
    "KO_KR",
    "PL_PL",
    "PT_BR",
    "PT_PT",
    "RO_RO",
    "RU_RU",
    "ES_ES",
    "ES_US",
    "SV_SE",
    "TR_TR",
    "UK_UA",
    "VI_VN",
    "AR_XA",
    "AR_DZ",
    "AR_BH",
    "AR_EG",
    "AR_IL",
    "AR_JO",
    "AR_KW",
    "AR_LB",
    "AR_MR",
    "AR_MA",
    "AR_OM",
    "AR_QA",
    "AR_SA",
    "AR_PS",
    "AR_SY",
    "AR_TN",
    "AR_AE",
    "AR_YE",
    "HY_AM",
    "BN_BD",
    "BN_IN",
    "BG_BG",
    "MY_MM",
    "AR_IQ",
    "YUE_HANT_HK",
    "CMN_HANT_TW",
    "CS_CZ",
    "EN_PH",
    "ET_EE",
    "FIL_PH",
    "GU_IN",
    "IW_IL",
    "HU_HU",
    "ID_ID",
    "KN_IN",
    "KM_KH",
    "LO_LA",
    "LV_LV",
    "LT_LT",
    "MS_MY",
    "ML_IN",
    "MR_IN",
    "NE_NP",
    "NO_NO",
    "FA_IR",
    "PA_GURU_IN",
    "SR_RS",
    "SK_SK",
    "SL_SI",
    "ES_MX",
    "SW",
    "TA_IN",
    "TE_IN",
    "TH_TH",
    "UZ_UZ"
  ]
}
```

###### GoogleSTTModel

```json
{
  "type": "string",
  "enum": [
    "chirp_3"
  ],
  "x-enumNames": [
    "CHIRP_3"
  ]
}
```

###### GoogleSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "google"
      ],
      "x-enumNames": [
        "GOOGLE"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/GoogleSTTModel"
    },
    "languages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GoogleSTTLanguage"
      }
    }
  },
  "required": [
    "provider",
    "model",
    "languages"
  ]
}
```

###### GoogleTTSModelID

```json
{
  "type": "string",
  "enum": [
    "standard",
    "wavenet",
    "neural2",
    "polyglot",
    "studio",
    "Chirp3-HD",
    "gemini-2.5-flash"
  ],
  "x-enumNames": [
    "STANDARD",
    "WAVENET",
    "NEURAL_2",
    "POLYGLOT",
    "STUDIO",
    "CHIRP_3_HD",
    "GEMINI_2_5_FLASH"
  ]
}
```

###### GoogleVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "google"
      ],
      "x-enumNames": [
        "GOOGLE"
      ]
    },
    "model": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GoogleTTSModelID"
        }
      ]
    },
    "languageCode": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "settings": {
      "type": "object",
      "properties": {
        "prompt": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

###### MicrosoftVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "microsoft"
      ],
      "x-enumNames": [
        "MICROSOFT"
      ]
    },
    "voice": {
      "type": "string"
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

###### PronunciationDictionaryEntry

```json
{
  "type": "object",
  "properties": {
    "from": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "to": {
      "type": "string",
      "maxLength": 128
    }
  },
  "required": [
    "from",
    "to"
  ]
}
```

###### RimelabsVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "rimelabs"
      ],
      "x-enumNames": [
        "RIMELABS"
      ]
    },
    "model": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "language": {
      "type": "string"
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

###### STTSettings

```json
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/ElevenLabsSTTSettings"
    },
    {
      "$ref": "#/components/schemas/DeepgramSTTSettings"
    },
    {
      "$ref": "#/components/schemas/AssemblyAISTTSettings"
    },
    {
      "$ref": "#/components/schemas/CartesiaSTTSettings"
    },
    {
      "$ref": "#/components/schemas/GladiaSTTSettings"
    },
    {
      "$ref": "#/components/schemas/GoogleSTTSettings"
    },
    {
      "$ref": "#/components/schemas/SonioxSTTSettings"
    }
  ]
}
```

###### SonioxSTTLanguage

```json
{
  "type": "string",
  "enum": [
    "auto",
    "af",
    "sq",
    "ar",
    "az",
    "eu",
    "be",
    "bn",
    "bs",
    "bg",
    "ca",
    "zh",
    "hr",
    "cs",
    "da",
    "nl",
    "en",
    "et",
    "fi",
    "fr",
    "gl",
    "de",
    "el",
    "gu",
    "he",
    "hi",
    "hu",
    "id",
    "it",
    "ja",
    "kn",
    "kk",
    "ko",
    "lv",
    "lt",
    "mk",
    "ms",
    "ml",
    "mr",
    "no",
    "fa",
    "pl",
    "pt",
    "pa",
    "ro",
    "ru",
    "sr",
    "sk",
    "sl",
    "es",
    "sw",
    "sv",
    "tl",
    "ta",
    "te",
    "th",
    "tr",
    "uk",
    "ur",
    "vi",
    "cy"
  ],
  "x-enumNames": [
    "AUTO",
    "AFRIKAANS",
    "ALBANIAN",
    "ARABIC",
    "AZERBAIJANI",
    "BASQUE",
    "BELARUSIAN",
    "BENGALI",
    "BOSNIAN",
    "BULGARIAN",
    "CATALAN",
    "CHINESE",
    "CROATIAN",
    "CZECH",
    "DANISH",
    "DUTCH",
    "ENGLISH",
    "ESTONIAN",
    "FINNISH",
    "FRENCH",
    "GALICIAN",
    "GERMAN",
    "GREEK",
    "GUJARATI",
    "HEBREW",
    "HINDI",
    "HUNGARIAN",
    "INDONESIAN",
    "ITALIAN",
    "JAPANESE",
    "KANNADA",
    "KAZAKH",
    "KOREAN",
    "LATVIAN",
    "LITHUANIAN",
    "MACEDONIAN",
    "MALAY",
    "MALAYALAM",
    "MARATHI",
    "NORWEGIAN",
    "PERSIAN",
    "POLISH",
    "PORTUGUESE",
    "PUNJABI",
    "ROMANIAN",
    "RUSSIAN",
    "SERBIAN",
    "SLOVAK",
    "SLOVENIAN",
    "SPANISH",
    "SWAHILI",
    "SWEDISH",
    "TAGALOG",
    "TAMIL",
    "TELUGU",
    "THAI",
    "TURKISH",
    "UKRAINIAN",
    "URDU",
    "VIETNAMESE",
    "WELSH"
  ]
}
```

###### SonioxSTTModel

```json
{
  "type": "string",
  "enum": [
    "stt-rt-v5"
  ],
  "x-enumNames": [
    "STT_RT_V_5"
  ]
}
```

###### SonioxSTTSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "soniox"
      ],
      "x-enumNames": [
        "SONIOX"
      ]
    },
    "model": {
      "$ref": "#/components/schemas/SonioxSTTModel"
    },
    "maxEndpointDelayMS": {
      "type": "integer",
      "minimum": 500,
      "maximum": 3000
    },
    "endpointSensitivity": {
      "type": "number",
      "minimum": -1,
      "maximum": 1
    },
    "keyterms": {
      "type": "string"
    },
    "languages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SonioxSTTLanguage"
      }
    }
  },
  "required": [
    "provider",
    "model",
    "languages"
  ]
}
```

###### SonioxVoiceSettings

```json
{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "soniox"
      ],
      "x-enumNames": [
        "SONIOX"
      ]
    },
    "model": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "language": {
      "type": "string"
    }
  },
  "required": [
    "provider",
    "voice"
  ]
}
```

###### VoiceKeypadSettings

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "delimiter": {
      "maxItems": 2,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DTMFDelimiter"
      }
    },
    "timeoutInSeconds": {
      "type": "number"
    }
  },
  "required": [
    "enabled",
    "delimiter",
    "timeoutInSeconds"
  ]
}
```

###### VoiceLocaleOverride

```json
{
  "type": "object",
  "properties": {
    "locale": {
      "type": "string",
      "minLength": 1,
      "description": "A language such as fr or a regional locale such as fr-FR."
    },
    "tts": {
      "$ref": "#/components/schemas/VoiceSettings"
    }
  },
  "required": [
    "locale",
    "tts"
  ]
}
```

###### VoiceMaxDurationSettings

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "seconds": {
      "nullable": true,
      "type": "number"
    },
    "message": {
      "nullable": true,
      "type": "string"
    }
  },
  "required": [
    "enabled",
    "seconds",
    "message"
  ]
}
```

###### VoiceSettings

```json
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/AmazonVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/GoogleVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/CartesiaVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/RimelabsVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/SonioxVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/MicrosoftVoiceSettings"
    },
    {
      "$ref": "#/components/schemas/ElevenLabsVoiceSettings"
    }
  ]
}
```

## Field behavior

<a id="voice-setting-fields" />

- **Recognition:** `stt` is a provider-discriminated object. Preserve its provider-specific fields when editing it.
- **Speech:** `tts` is the default voice; `localeOverrides` selects a replacement by session `locale`. `pronunciationDictionary`, `audioCue`, `backgroundAudio`, `backgroundAudioSettings` and `audioSync` configure output.
- **Phone input:** `keypadInput` contains `enabled`, `delimiter` (`#`, `*`) and `timeoutInSeconds`.
- **Call lifetime:** `maxDuration` contains `enabled`, `seconds` and nullable `message`. `silenceTimeoutMs` is a legacy fallback in milliseconds: an enabled positive `session.idleTimeout.timeoutMs` takes precedence. Do not use this field as a substitute for Studio’s current Inactivity timeout.
- **Caller state:** `callerIdentity: "phone-number"` retains returning-caller identity; `"call"` creates a new runtime identity for each call. Omitted retains phone-number behavior.
- **Recording:** `hasCallRecording` and `hasProviderCallRecording` are separate fields. Creator disables recording when enabling PII redaction; do not infer that an arbitrary API-written combination is a supported privacy configuration.

PATCH merges top-level fields. `keypadInput` receives a nested merge; other supplied nested objects are replaced. A read returns `{ "voice": ... }`; PATCH returns 204 without a body. A 404 also covers Environments without Voice settings.

## Minimal update

```json title="A focused patch"
{"callerIdentity":"call"}
```

This changes caller state without replacing `stt` or `tts`. Values are illustrative.

## Errors and recovery

A `404` also means the Environment has no Voice settings. Resolve schema and permission failures before retrying. Read back the saved settings after a successful 204 response.

## Related workflows

Use [Voice configuration](/docs/documentation/build/voice) for shared behavior, [Studio setup](/docs/guides/studio/voice/configure-voice) for the interface and [Voice agents](/docs/api-reference/agent-runtime/voice) for execution contracts.
