Sign in

v3

OpenAPI 3.1.02026-07-31350397683.8 KB
Digital Humans

Update Digital Human

Update a digital human by ID.

put/v1/update-digital-human/{digital_human_id}

Path parameters

digital_human_idinteger required

Headers

X-API-Keystring required

API key required to authenticate requests.

Request body

intentstring nullable

Description of the digital human

success_criteriastring nullable

Success criteria for the digital human

namestring nullable

Name of the digital human

tagstring nullable

Tag for categorizing the digital human

language'en' | 'es' | 'pt' | 'ja' | 'tr' | 'hi' | 'ar' | 'he' | 'ru' | 'zh' | 'ml' | 'fr' | 'yue' | 'vi' | 'de' | 'ko' | 'ur' | 'te' | 'ta' | 'mal' | 'kn' | 'mr' | 'gu' | 'ad'

Enum for supported language types.

accent'multilingual' | 'american' | 'american2' | 'mature' | 'southern' | 'italian' | 'indian' | 'british' | 'australian' | 'scottish' | 'irish' | 'welsh' | 'mexican' | 'spanish' | 'portuguese' | 'french' | 'turkish' | 'japanese' | 'hindi' | 'arabic' | 'egyptian' | 'levantine' | 'hebrew' | 'russian' | 'chinese' | 'german' | 'korean' | 'urdu' | 'telugu' | 'tamil' | 'malayalam' | 'kannada' | 'marathi' | 'gujarati' | 'autodetect'

Enum for accent options.

gender'male' | 'female'

Enum for gender options.

custom_voice_idstring nullable

ElevenLabs voice_id of a cloned voice. Send empty string or null to clear and revert to the stock accent voice.

background_noise'none' | 'office' | 'talking' | 'traffic' | 'cafe' | 'park' | 'tv' | 'noisy_restaurant' | 'hospital' | 'custom'

Enum for background noise options.

custom_background_noise_urlstring nullable

Bucket-relative path of the uploaded custom background noise audio; required when background_noise is 'custom'

voice_speed'slowest' | 'slow' | 'normal' | 'fast' | 'fastest'

Enum for voice speed options.

audio_quality'high' | 'medium' | 'low' | 'horrible'

Enum for audio quality options.

fluency'beginner' | 'intermediate' | 'native'

Enum for fluency level options.

verbosity'low' | 'medium' | 'high'

Enum for verbosity level options.

phone_numberstring nullable

Phone number for the digital human

extensionstring nullable

Extension dialed as DTMF after connecting when this DH calls an inbound agent

outbound_text_numberstring nullable

Outbound text number

follow_up_sms_success_criteriastring nullable

Criteria the captured follow-up SMS is graded against

background_noise_volumenumber nullable

Volume of background noise

allow_end_call_toolboolean nullable

Allow the digital human to end the tool call

allow_silence_toolboolean nullable

Allow the digital human to use the silence tool

allow_dtmf_toolboolean nullable

Allow the digital human to use the DTMF tool

default_dtmf_or_voiced'voiced' | 'dtmf'

Enum for DTMF vs voiced input mode.

silence_tool_instructionsstring nullable

Tool instructions; set to "default" for built-in behavior or custom text

endpointing_delaynumber nullable

Delay for endpointing

creativitynumber nullable

How creative the digital human is (Model temperature)

hangup_phrasesstring[] nullable

Phrases that trigger hangup

hangup_instructionsstring nullable

Freeform instructions for how/when to hang up

silence_timeoutinteger nullable

Silence timeout in seconds

simulation_idsinteger[] nullable

Array of simulation IDs to associate with this digital human. If provided, completely replaces existing associations.

role_descriptionstring nullable

Description of the role for the digital human

original_transcriptstring nullable

Original transcript text. If changed from the current value, utterances are re-extracted and the intent is regenerated.

formatted_transcriptobject[] nullable

Pre-computed structured transcript as [{role, utterance}]. When provided alongside original_transcript, skips the LLM formatting call.

enriched_playbackobject[] nullable

Optional enriched playback stored as JSONB: a list of turn objects

num_runsinteger nullable

Number of times this digital human is run per simulation run (run count).

livekit_metadataobject nullable

LiveKit-specific configuration and metadata for this digital human. If provided, completely replaces existing metadata.

always_on_modeboolean nullable

Whether always-on mode is enabled for this digital human

always_on_activeboolean nullable

When true, this DH actively receives calls on phone_number; when false, number is assigned but inactive

test_namestring nullable

User-facing label for this digital human

override_conflictboolean nullable

When true, allows activation to replace an existing always-on active DH using the same phone number.

Response

Successful Response

simulation_idsinteger[] nullable

List of simulation IDs associated with this digital human

simulation_idinteger nullable

ID of the associated simulation. Use simulation_ids instead.