Sign in
Personalities

Update Personality

patch/v1/personalities/{personality_id}

Path parameters

personality_idstring required

Headers

X-Organization-Idstring
X-API-Keystring required

API key required to authenticate requests.

Request body

languagestring nullable

Language code, e.g. 'en'

accentstring nullable

Accent, e.g. 'american'

genderstring nullable

Voice gender; with language and accent this picks the stock voice

background_noise'none' | 'office' | 'talking' | 'traffic' | 'cafe' | 'park' | 'tv' | 'noisy_restaurant' | 'hospital' | 'airport' | 'street' | 'subway_station' | 'supermarket' | 'construction' | 'rain' | 'wind' | 'quiet_home' | 'driving' | 'factory' | 'school' nullable
background_noise_volumenumber nullable
custom_background_noise_urlstring nullable
voice_speed'slowest' | 'slow' | 'normal' | 'fast' | 'fastest' nullable
audio_quality'horrible' | 'low' | 'medium' | 'high' nullable
connection_quality'none' | 'low' | 'medium' | 'high' nullable
fluency'beginner' | 'intermediate' | 'native' nullable
verbosity'low' | 'medium' | 'high' nullable
endpointing_delaynumber nullable
silence_timeoutinteger nullable
temperaturenumber nullable
interruption_configsobject nullable
role_descriptionstring nullable

Personality: who the caller is and how they come across. Replaces the digital human's own when this personality runs.

namestring nullable

Response

Successful Response

idstring uuid nullable
organization_idstring uuid required
namestring required
languagestring nullable
accentstring nullable
genderstring nullable
background_noisestring nullable
background_noise_volumenumber nullable
custom_background_noise_urlstring nullable
voice_speedstring nullable
audio_qualitystring nullable
connection_qualitystring nullable
fluencystring nullable
verbositystring nullable
endpointing_delaynumber nullable
silence_timeoutinteger nullable
temperaturenumber nullable
interruption_configsobject nullable
role_descriptionstring nullable
created_bystring uuid nullable
created_atstring date-time nullable
updated_atstring date-time nullable

Changes

Changed in 3 of the 38 revisions of this API.5

  • 367800ade25a2See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • d6cc6baba47c2See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 582b3e7c58b71See the full diff
    • ○

      endpoint added

      endpoint-added