Release Notes
Build
Analyze
watsonx Orchestrate Developer Edition
watsonx Orchestrate MCP Server
Legal notices
Update Voice Configuration
Copy
Ask AI
curl --request PATCH \
--url https://{api_endpoint}/api/v1/voice_configurations/{voice_configuration_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"llm_aggregation_timeout_seconds": 123,
"speech_to_text": {
"provider": "<string>",
"watson_stt_config": {
"api_url": "<string>",
"model": "<string>",
"api_key": "<string>",
"bearer_token": "<string>",
"end_of_phrase_silence_time": 123,
"background_audio_suppression": 0.5,
"language_customization_id": "<string>",
"inactivity_timeout": 0,
"profanity_filter": true,
"smart_formatting": true,
"speaker_labels": true,
"redaction": true,
"low_latency": true,
"learning_opt_out": true,
"watson_metadata": "<string>",
"smart_formatting_version": 1,
"customization_weight": 0.5,
"character_insertion_bias": 0
},
"emotech_stt_config": {
"api_url": "<string>",
"api_key": "<string>",
"positive_speech_threshold": 0.25,
"negative_speech_threshold": 0.25,
"partial_interval": 500,
"silence_threshold": 500
}
},
"text_to_speech": {
"provider": "<string>",
"watson_tts_config": {
"api_url": "<string>",
"api_key": "<string>",
"bearer_token": "<string>",
"voice": "<string>",
"rate_percentage": 0,
"pitch_percentage": 0,
"language": "<string>",
"customization_id": "<string>",
"meta_id": "<string>",
"learning_opt_out": true
},
"emotech_tts_config": {
"api_url": "<string>",
"api_key": "<string>",
"voice": "<string>"
},
"elevenlabs_tts_config": {
"model_id": "<string>",
"voice_id": "<string>",
"api_key": "<string>",
"apply_text_normalization": "<string>",
"language_code": "<string>",
"optimize_streaming_latency": 123,
"apply_language_text_normalization": true,
"pronunciation_dictionary_locators": [
{
"pronunciation_dictionary_id": "<string>",
"version_id": "<string>"
}
],
"seed": 123,
"previous_text": "<string>",
"next_text": "<string>",
"voice_settings": {
"speed": 123,
"style": 123,
"stability": 123,
"similarity_boost": 123,
"use_speaker_boost": true
}
}
},
"language": "<string>",
"additional_languages": {},
"dtmf_input": {
"inter_digit_timeout_ms": 123,
"termination_key": "<string>",
"maximum_count": 123,
"ignore_speech": true
},
"vad": {
"provider": "<string>",
"enabled": true,
"silero_vad_config": {
"confidence": 123,
"start_seconds": 123,
"stop_seconds": 123,
"min_volume": 123
}
}
}
'Copy
Ask AI
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Voice Configurations
Update Voice Configuration
PATCH
/
v1
/
voice_configurations
/
{voice_configuration_id}
Update Voice Configuration
Copy
Ask AI
curl --request PATCH \
--url https://{api_endpoint}/api/v1/voice_configurations/{voice_configuration_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"llm_aggregation_timeout_seconds": 123,
"speech_to_text": {
"provider": "<string>",
"watson_stt_config": {
"api_url": "<string>",
"model": "<string>",
"api_key": "<string>",
"bearer_token": "<string>",
"end_of_phrase_silence_time": 123,
"background_audio_suppression": 0.5,
"language_customization_id": "<string>",
"inactivity_timeout": 0,
"profanity_filter": true,
"smart_formatting": true,
"speaker_labels": true,
"redaction": true,
"low_latency": true,
"learning_opt_out": true,
"watson_metadata": "<string>",
"smart_formatting_version": 1,
"customization_weight": 0.5,
"character_insertion_bias": 0
},
"emotech_stt_config": {
"api_url": "<string>",
"api_key": "<string>",
"positive_speech_threshold": 0.25,
"negative_speech_threshold": 0.25,
"partial_interval": 500,
"silence_threshold": 500
}
},
"text_to_speech": {
"provider": "<string>",
"watson_tts_config": {
"api_url": "<string>",
"api_key": "<string>",
"bearer_token": "<string>",
"voice": "<string>",
"rate_percentage": 0,
"pitch_percentage": 0,
"language": "<string>",
"customization_id": "<string>",
"meta_id": "<string>",
"learning_opt_out": true
},
"emotech_tts_config": {
"api_url": "<string>",
"api_key": "<string>",
"voice": "<string>"
},
"elevenlabs_tts_config": {
"model_id": "<string>",
"voice_id": "<string>",
"api_key": "<string>",
"apply_text_normalization": "<string>",
"language_code": "<string>",
"optimize_streaming_latency": 123,
"apply_language_text_normalization": true,
"pronunciation_dictionary_locators": [
{
"pronunciation_dictionary_id": "<string>",
"version_id": "<string>"
}
],
"seed": 123,
"previous_text": "<string>",
"next_text": "<string>",
"voice_settings": {
"speed": 123,
"style": 123,
"stability": 123,
"similarity_boost": 123,
"use_speaker_boost": true
}
}
},
"language": "<string>",
"additional_languages": {},
"dtmf_input": {
"inter_digit_timeout_ms": 123,
"termination_key": "<string>",
"maximum_count": 123,
"ignore_speech": true
},
"vad": {
"provider": "<string>",
"enabled": true,
"silero_vad_config": {
"confidence": 123,
"start_seconds": 123,
"stop_seconds": 123,
"min_volume": 123
}
}
}
'Copy
Ask AI
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Required string length:
1 - 128Show child attributes
Show child attributes
Required string length:
1 - 128Show child attributes
Show child attributes
Required string length:
1 - 2048Required string length:
1 - 256Required string length:
1 - 2048Required string length:
1 - 2048Background audio suppression level (0.0 to 1.0). Default 0.0
Required range:
0 <= x <= 1Language customization ID
Required string length:
1 - 256Seconds of inactivity before the service stops listening. Default 30
Required range:
x >= -1Filter profanity in the transcript. Default true
Enable smart formatting (beta). Default false
Enable speaker labels (beta). Default false
Enable PII redaction (beta). Default false
Enable low latency mode. Default false
Opt out of data collection for learning. Default true
Value for x-watson-metadata header.
Required string length:
1 - 512Version of smart formatting to use.
Required range:
x >= 0Weight for custom language model (0.0 to 1.0). Default 0.5
Required range:
0 <= x <= 1Bias for character insertion (-1.0 to 1.0). Default 0.0
Required range:
-1 <= x <= 1Show child attributes
Show child attributes
Required string length:
1 - 2048Required string length:
1 - 2048Confidence threshold above which audio is classified as speech, default is 0.25
Confidence threshold below which audio is classified as non-speech, default is 0.25
Time interval (in ms) between partial transcription results, default is 500 ms.
Silence duration (in ms) after speech used to determine end of utterance, default is 1500 ms.
Show child attributes
Show child attributes
Required string length:
1 - 128Show child attributes
Show child attributes
Required string length:
1 - 2048Required string length:
1 - 2048Required string length:
1 - 2048Required string length:
1 - 128Rate percentage for speech synthesis, default is 0
Pitch percentage for speech synthesis, default is 0
Language code for the voice, e.g., 'en-US'
Required string length:
2 - 16Custom ID for the Watson TTS service
Required string length:
1 - 256Meta ID for the Watson TTS service
Required string length:
1 - 256Set to true to opt out of data collection for learning purposes
Show child attributes
Show child attributes
Required string length:
1 - 128Required string length:
1 - 128Required string length:
1 - 2048Required string length:
2 - 16text_to_speech.elevenlabs_tts_config.pronunciation_dictionary_locators
UpdateElevenLabsPronounciationDict · object[] | null
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Speech speed
Style factor
Stability factor
Similarity boost factor
Whether to use speaker boost
Default language code, e.g., 'en-us'
Required string length:
2 - 16Additional language configurations keyed by language code
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required string length:
1 - 128Show child attributes
Show child attributes
Required string length:
1 - 2048Required string length:
1 - 2048Required string length:
1 - 2048Required string length:
1 - 128Rate percentage for speech synthesis, default is 0
additional_languages.{key}.text_to_speech.watson_tts_config.pitch_percentage
integer | null
default:0
Pitch percentage for speech synthesis, default is 0
Language code for the voice, e.g., 'en-US'
Required string length:
2 - 16Custom ID for the Watson TTS service
Required string length:
1 - 256Meta ID for the Watson TTS service
Required string length:
1 - 256Set to true to opt out of data collection for learning purposes
Show child attributes
Show child attributes
Required string length:
1 - 2048Required string length:
1 - 2048Required string length:
1 - 128Show child attributes
Show child attributes
Required string length:
1 - 128Required string length:
1 - 128Required string length:
1 - 2048additional_languages.{key}.text_to_speech.elevenlabs_tts_config.apply_text_normalization
string | null
Required string length:
2 - 16additional_languages.{key}.text_to_speech.elevenlabs_tts_config.optimize_streaming_latency
integer | null
additional_languages.{key}.text_to_speech.elevenlabs_tts_config.apply_language_text_normalization
boolean | null
additional_languages.{key}.text_to_speech.elevenlabs_tts_config.pronunciation_dictionary_locators
UpdateElevenLabsPronounciationDict · object[] | null
Show child attributes
Show child attributes
additional_languages.{key}.text_to_speech.elevenlabs_tts_config.pronunciation_dictionary_locators.pronunciation_dictionary_id
string | null
ID of the pronunciation dictionary
additional_languages.{key}.text_to_speech.elevenlabs_tts_config.pronunciation_dictionary_locators.version_id
string | null
Version ID of the pronunciation dictionary
additional_languages.{key}.text_to_speech.elevenlabs_tts_config.voice_settings
UpdateElevenLabsVoiceSettings · object
Show child attributes
Show child attributes
Speech speed
Style factor
additional_languages.{key}.text_to_speech.elevenlabs_tts_config.voice_settings.stability
number | null
Stability factor
additional_languages.{key}.text_to_speech.elevenlabs_tts_config.voice_settings.similarity_boost
number | null
Similarity boost factor
additional_languages.{key}.text_to_speech.elevenlabs_tts_config.voice_settings.use_speaker_boost
boolean | null
Whether to use speaker boost
Show child attributes
Show child attributes
Required string length:
1 - 128Show child attributes
Show child attributes
Required string length:
1 - 2048Required string length:
1 - 256Required string length:
1 - 2048Required string length:
1 - 2048additional_languages.{key}.speech_to_text.watson_stt_config.end_of_phrase_silence_time
number | null
additional_languages.{key}.speech_to_text.watson_stt_config.background_audio_suppression
number | null
Background audio suppression level (0.0 to 1.0). Default 0.0
Required range:
0 <= x <= 1Language customization ID
Required string length:
1 - 256Seconds of inactivity before the service stops listening. Default 30
Required range:
x >= -1Filter profanity in the transcript. Default true
Enable smart formatting (beta). Default false
Enable speaker labels (beta). Default false
Enable PII redaction (beta). Default false
Enable low latency mode. Default false
Opt out of data collection for learning. Default true
Value for x-watson-metadata header.
Required string length:
1 - 512Version of smart formatting to use.
Required range:
x >= 0Weight for custom language model (0.0 to 1.0). Default 0.5
Required range:
0 <= x <= 1Bias for character insertion (-1.0 to 1.0). Default 0.0
Required range:
-1 <= x <= 1Show child attributes
Show child attributes
Required string length:
1 - 2048Required string length:
1 - 2048additional_languages.{key}.speech_to_text.emotech_stt_config.positive_speech_threshold
number | null
default:0.25
Confidence threshold above which audio is classified as speech, default is 0.25
additional_languages.{key}.speech_to_text.emotech_stt_config.negative_speech_threshold
number | null
default:0.25
Confidence threshold below which audio is classified as non-speech, default is 0.25
additional_languages.{key}.speech_to_text.emotech_stt_config.partial_interval
integer | null
default:500
Time interval (in ms) between partial transcription results, default is 500 ms.
additional_languages.{key}.speech_to_text.emotech_stt_config.silence_threshold
integer | null
default:500
Silence duration (in ms) after speech used to determine end of utterance, default is 1500 ms.
Show child attributes
Show child attributes
Required string length:
1 - 128Response
Successful Response
⌘I