Sign in
voice

Create a voice pipeline config for an agent or persona (1:1)

post/v1/voice/configs

Request body

voice_tuningobject nullable
stt_providerstring nullable
stt_modelstring nullable
stt_provider_dataobject nullable
tts_speednumber nullable
vad_provider_dataobject nullable
pronunciation_overridesobject nullable
noise_cancellation_enabledboolean nullable
noise_cancellation_provider'rnnoise' | 'dtln'

Noise-suppression engine wired by audio_filters.build_audio_in_filter.

Applies only when noise_cancellation_enabled. String values MUST match the provider strings the factory dispatches on.

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
agent_idstring uuid nullable
team_idstring uuid nullable
persona_idstring uuid nullable
voice_idstring uuid required

Response

Successful Response

idstring uuid required
organization_idstring uuid nullable
namestring 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
interruption_sensitivitynumber required
hard_turn_timeout_msinteger nullable
min_endpoint_delay_msinteger required
max_endpoint_delay_msinteger required
preemptive_generation_enabledboolean required
end_call_phrasesstring[]
pronunciation_overridesobject
noise_cancellation_enabledboolean required
noise_cancellation_provider'rnnoise' | 'dtln' required

Noise-suppression engine wired by audio_filters.build_audio_in_filter.

Applies only when noise_cancellation_enabled. String values MUST match the provider strings the factory dispatches on.

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[]
linked_agent_countinteger
linked_agent_namesstring[]
linked_team_countinteger
linked_team_namesstring[]
metadata_object
warningsstring[]
effective_stt_modelstring nullable
effective_stt_provider_dataobject nullable
effective_tts_modelstring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

Changed in 1 of the 3 revisions of this API.253715

  • 5a5597ebb2d6253715See the full diff
    • ▲

      removed subschema #1 from the tts_provider_data request property anyOf list

      request-property-any-of-removed

    • ▲

      the provider response property const value elevenlabs was removed for the status 201

      response-property-const-removed

    • ▲

      removed the required property backchannel_enabled from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property background_audio_enabled from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property background_audio_loop from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property background_audio_volume from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property dtmf_enabled from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property dtmf_inter_digit_timeout_ms from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property dtmf_max_digits from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property dtmf_prefix from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property dtmf_termination_digit from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property interruption_backoff_ms from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property interruption_final_transcript_grace_ms from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property interruption_min_duration_ms from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property interruption_min_words from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property interruptions_enabled from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property max_call_duration_ms from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property recording_enabled from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property silence_end_action from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property silence_reminder_count from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property silence_reminder_mode from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property silence_timeout_ms from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property transcription_storage_enabled from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property voicemail_detection_mode from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property voicemail_detection_timeout_ms from the response with the 201 status

      response-required-property-removed

    • ●

      removed the request property background_audio_enabled

      request-property-removed

    • ●

      removed the request property background_audio_loop

      request-property-removed

    • ●

      removed the request property background_audio_preset

      request-property-removed

    • ●

      removed the request property background_audio_volume

      request-property-removed

    • ●

      removed the request property dtmf_enabled

      request-property-removed

    • ●

      removed the request property dtmf_inter_digit_timeout_ms

      request-property-removed

    • ●

      removed the request property dtmf_max_digits

      request-property-removed

    • ●

      removed the request property dtmf_prefix

      request-property-removed

    • ●

      removed the request property dtmf_termination_digit

      request-property-removed

    • ●

      removed the request property interruption_backoff_ms

      request-property-removed

    • ●

      removed the request property interruption_final_transcript_grace_ms

      request-property-removed

    • ●

      removed the request property interruption_hard_phrases

      request-property-removed

    • ●

      removed the request property interruption_min_duration_ms

      request-property-removed

    • ●

      removed the request property interruption_min_words

      request-property-removed

    • ●

      removed the request property interruption_trigger_phrases

      request-property-removed

    • ●

      removed the request property interruptions_enabled

      request-property-removed

    • ●

      removed the request property max_call_duration_ms

      request-property-removed

    • ●

      removed the request property silence_end_action

      request-property-removed

    • ●

      removed the request property silence_end_message

      request-property-removed

    • ●

      removed the request property silence_reminder_count

      request-property-removed

    • ●

      removed the request property silence_reminder_message

      request-property-removed

    • ●

      removed the request property silence_reminder_mode

      request-property-removed

    • ●

      removed the request property silence_timeout_ms

      request-property-removed

    • ●

      removed the request property voicemail_detection_mode

      request-property-removed

    • ●

      removed the request property voicemail_detection_model

      request-property-removed

    • ●

      removed the request property voicemail_detection_timeout_ms

      request-property-removed

    • ●

      removed the request property voicemail_message

      request-property-removed

    • ●

      removed the optional property backchannel_frequency from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property background_audio_preset from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property interruption_hard_phrases from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property interruption_trigger_phrases from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property silence_end_message from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property silence_reminder_message from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property voicemail_detection_model from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property voicemail_message from the response with the 201 status

      response-optional-property-removed

    • ●

      added the new elevenlabs enum value to the voice/provider response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new inworld enum value to the voice/provider response property for the response status 201

      response-property-enum-value-added

    • ○

      added the new optional request property noise_cancellation_provider

      new-optional-request-property

    • ○

      added VoiceTTSProviderDataInput to the tts_provider_data request property anyOf list

      request-property-any-of-added

    • ○

      added the optional property effective_stt_model to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property effective_stt_provider_data to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property effective_tts_model to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property linked_agent_count to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property linked_agent_names to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property linked_team_count to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property linked_team_names to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property name to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property retry_after to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property retry_after to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property retryable to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property retryable to the response with the 401 status

      response-optional-property-added

    • ○

      added the required property noise_cancellation_provider to the response with the 201 status

      response-required-property-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog