voice
Partial update of a voice pipeline config
patch/v1/voice/configs/{config_id}
Path parameters
config_idstring uuid required
Request body
voice_tuningobject nullable
stt_providerstring nullable
stt_modelstring nullable
stt_provider_dataobject nullable
tts_speednumber nullable
tts_provider_dataobject nullable
vad_provider_dataobject nullable
interruptions_enabledboolean nullable
interruption_min_wordsinteger nullable
interruption_min_duration_msinteger nullable
interruption_backoff_msinteger nullable
interruption_trigger_phrasesstring[] nullable
interruption_hard_phrasesstring[] nullable
interruption_final_transcript_grace_msinteger nullable
voicemail_detection_mode'off' | 'leave_message'
voicemail_detection_timeout_msinteger nullable
voicemail_detection_modelstring nullable
voicemail_messagestring nullable
max_call_duration_msinteger nullable
silence_timeout_msinteger nullable
silence_reminder_countinteger nullable
silence_reminder_mode'static' | 'auto'
silence_reminder_messagestring nullable
silence_end_action'hangup_immediate' | 'speak_then_hangup'
silence_end_messagestring nullable
dtmf_enabledboolean nullable
dtmf_termination_digitstring nullable
dtmf_inter_digit_timeout_msinteger nullable
dtmf_max_digitsinteger nullable
dtmf_prefixstring nullable
pronunciation_overridesobject nullable
noise_cancellation_enabledboolean nullable
background_audio_enabledboolean nullable
background_audio_preset'office' | 'cafe' | 'city' | 'keyboard_typing' | 'keyboard_typing2'
Bundled CC0 ambience presets resolved by the voice worker.
String values MUST match the keys of _PRESET_FILES in src/communication/voice/agent/background_audio.py; a unit test (tests/voice/test_background_audio.py) fails CI if the two ever drift.
background_audio_volumenumber nullable
background_audio_loopboolean nullable
languagestring nullable
localestring nullable
multilingual_enabledboolean nullable
multilingual_languagesstring[] nullable
first_speaker'agent' | 'user' nullable
mode'static' | 'dynamic' nullable
textstring nullable
instructionsstring nullable
interruptibleboolean nullable
ai_disclosure_textstring nullable
voice_idstring uuid nullable
Response
Successful Response
idstring uuid required
organization_idstring uuid nullable
agent_idstring uuid nullable
team_idstring uuid nullable
persona_idstring uuid nullable
voice_idstring uuid required
voice_tuningobject
stt_providerstring required
stt_modelstring nullable
stt_languagestring required
stt_provider_dataobject
tts_speednumber nullable
tts_provider_dataobject
vad_providerstring required
vad_provider_dataobject
local_vad_paramsobject
turn_analyzer_paramsobject
interruptions_enabledboolean required
interruption_min_wordsinteger required
interruption_min_duration_msinteger required
interruption_backoff_msinteger required
interruption_sensitivitynumber required
interruption_trigger_phrasesstring[]
interruption_hard_phrasesstring[]
interruption_final_transcript_grace_msinteger required
hard_turn_timeout_msinteger nullable
min_endpoint_delay_msinteger required
max_endpoint_delay_msinteger required
preemptive_generation_enabledboolean required
voicemail_detection_modestring required
voicemail_detection_timeout_msinteger required
voicemail_detection_modelstring nullable
voicemail_messagestring nullable
max_call_duration_msinteger required
end_call_phrasesstring[]
silence_timeout_msinteger required
silence_reminder_countinteger required
silence_reminder_modestring required
silence_reminder_messagestring nullable
silence_end_actionstring required
silence_end_messagestring nullable
dtmf_enabledboolean required
dtmf_termination_digitstring required
dtmf_inter_digit_timeout_msinteger required
dtmf_max_digitsinteger required
dtmf_prefixstring required
backchannel_enabledboolean required
backchannel_frequencyinteger nullable
pronunciation_overridesobject
background_audio_presetstring nullable
background_audio_volumenumber required
background_audio_loopboolean required
background_audio_enabledboolean required
noise_cancellation_enabledboolean required
recording_enabledboolean required
transcription_storage_enabledboolean required
normalize_for_speechboolean required
audio_in_sample_rateinteger required
audio_out_sample_rateinteger required
metrics_enabledboolean required
usage_metrics_enabledboolean required
heartbeats_period_secsinteger nullable
idle_pipeline_timeout_msinteger nullable
languagestring required
localestring nullable
multilingual_enabledboolean required
multilingual_languagesstring[]
metadata_object
warningsstring[]
created_atstring date-time required
updated_atstring date-time required