Sign in
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' | 'tl' | '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' | 'vietnamese' | 'cantonese' | 'tagalog' | 'autodetect' | 'watson' | 'watsonbritish' | 'watsonaustralian' | 'watsoncanadian'

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. Send null or an empty string to clear it.

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.

scripted_responses_orderedboolean nullable

When true, scripted_responses run as a script in list order: only the next unfired one is armed, each fires once, and a blank match_phrase fires on the digital human's next turn. When false any scripted response fires whenever its match_phrase comes up.

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.

Changes

Changed in 7 of the 19 revisions of this API.1236

  • b1479366b1732See the full diff
    • ○

      added the new optional request property journey_steps/anyOf[subschema #1]/items/phone_number

      new-optional-request-property

    • ○

      added the optional property digital_human/journey_steps/anyOf[subschema #1]/items/phone_number to the response with the 200 status

      response-optional-property-added

  • b5daa886f4ee2See the full diff
    • ○

      added the new optional request property speaks_first_config/anyOf[subschema #1: SpeaksFirstConfig]/dynamic

      new-optional-request-property

    • ○

      added the optional property digital_human/speaks_first_config/anyOf[subschema #1: SpeaksFirstConfig]/dynamic to the response with the 200 status

      response-optional-property-added

  • b29e1840a3866See the full diff
    • ○

      added the optional property digital_human/always_on_active to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property digital_human/always_on_mode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property digital_human/attack_plan to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property digital_human/attack_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property digital_human/attack_vector to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property digital_human/num_runs to the response with the 200 status

      response-optional-property-added

  • 0f30448dd2a246See the full diff
    • ●

      added the new watson enum value to the digital_human/accent/anyOf[subschema #1: AccentType]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new watsonaustralian enum value to the digital_human/accent/anyOf[subschema #1: AccentType]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new watsonbritish enum value to the digital_human/accent/anyOf[subschema #1: AccentType]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new watsoncanadian enum value to the digital_human/accent/anyOf[subschema #1: AccentType]/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional request property scripted_responses_ordered

      new-optional-request-property

    • ○

      added the new watson enum value to the request property accent/anyOf[subschema #1: AccentType]/

      request-property-enum-value-added

    • ○

      added the new watsonaustralian enum value to the request property accent/anyOf[subschema #1: AccentType]/

      request-property-enum-value-added

    • ○

      added the new watsonbritish enum value to the request property accent/anyOf[subschema #1: AccentType]/

      request-property-enum-value-added

    • ○

      added the new watsoncanadian enum value to the request property accent/anyOf[subschema #1: AccentType]/

      request-property-enum-value-added

    • ○

      added the optional property digital_human/scripted_responses_ordered to the response with the 200 status

      response-optional-property-added

  • 4ef94eeb836d44See the full diff
    • ●

      added the new cantonese enum value to the digital_human/accent/anyOf[subschema #1: AccentType]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new tagalog enum value to the digital_human/accent/anyOf[subschema #1: AccentType]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new tl enum value to the digital_human/language/anyOf[subschema #1: LanguageType]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new vietnamese enum value to the digital_human/accent/anyOf[subschema #1: AccentType]/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new cantonese enum value to the request property accent/anyOf[subschema #1: AccentType]/

      request-property-enum-value-added

    • ○

      added the new tagalog enum value to the request property accent/anyOf[subschema #1: AccentType]/

      request-property-enum-value-added

    • ○

      added the new tl enum value to the request property language/anyOf[subschema #1: LanguageType]/

      request-property-enum-value-added

    • ○

      added the new vietnamese enum value to the request property accent/anyOf[subschema #1: AccentType]/

      request-property-enum-value-added

  • 4309a961859b2See the full diff
    • ○

      added the new optional request property extension

      new-optional-request-property

    • ○

      added the optional property digital_human/extension to the response with the 200 status

      response-optional-property-added

  • 44d183272ce1414See the full diff
    • ●

      added the new egyptian enum value to the digital_human/accent/anyOf[subschema #1: AccentType]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new he enum value to the digital_human/language/anyOf[subschema #1: LanguageType]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new hebrew enum value to the digital_human/accent/anyOf[subschema #1: AccentType]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new levantine enum value to the digital_human/accent/anyOf[subschema #1: AccentType]/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional request property journey_steps/anyOf[subschema #1]/items/direction

      new-optional-request-property

    • ○

      added the new optional request property journey_steps/anyOf[subschema #1]/items/modality

      new-optional-request-property

    • ○

      added the new optional request property journey_steps/anyOf[subschema #1]/items/response_window_seconds

      new-optional-request-property

    • ○

      added the new optional request property journey_steps/anyOf[subschema #1]/items/unresponsive

      new-optional-request-property

    • ○

      added the new optional request property journey_steps/anyOf[subschema #1]/items/wait_seconds

      new-optional-request-property

    • ○

      added the new egyptian enum value to the request property accent/anyOf[subschema #1: AccentType]/

      request-property-enum-value-added

    • ○

      added the new he enum value to the request property language/anyOf[subschema #1: LanguageType]/

      request-property-enum-value-added

    • ○

      added the new hebrew enum value to the request property accent/anyOf[subschema #1: AccentType]/

      request-property-enum-value-added

    • ○

      added the new levantine enum value to the request property accent/anyOf[subschema #1: AccentType]/

      request-property-enum-value-added

    • ○

      added the optional property digital_human/journey_steps/anyOf[subschema #1]/items/direction to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property digital_human/journey_steps/anyOf[subschema #1]/items/modality to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property digital_human/journey_steps/anyOf[subschema #1]/items/response_window_seconds to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property digital_human/journey_steps/anyOf[subschema #1]/items/unresponsive to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property digital_human/journey_steps/anyOf[subschema #1]/items/wait_seconds to the response with the 200 status

      response-optional-property-added

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