Skip to content
Embabel Worlds

Set this user's preferred voice and effects

PUT
/api/v1/profile/voice
curl --request PUT \
  --url http://localhost:11044/api/v1/profile/voice \
  --header 'Content-Type: application/json' \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>' \
  --data '{ "effects": [ "example" ], "voiceName": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

The voice preference, replacing the stored one: voiceName is a voice id from GET /profile/voice, blank or omitted clearing it, and effects the effect names to apply, omitted or empty clearing them. Neither is checked against what GET /profile/voice offers

Media typeapplication/json

Voice preferences to store, the body of PUT /profile/voice. Both fields are replaced

object
effects
required

Effect presets to apply; blank entries are dropped, and an empty or absent list clears them

Array<string>
voiceName

Voice id from the voices list; absent or blank resets to the deployment’s default voice

string

Example generated

{
  "effects": [
    "example"
  ],
  "voiceName": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*

The user’s voice preferences and the voices on offer, answered by GET and PUT /profile/voice

object
available
required

False when no voice can be offered to this user (no voice key, or the voice catalogue is empty or could not be read); a client should then hide voice controls

boolean
effects
required

Effect presets this deployment offers, e.g. warm, radio, echo

Array<string>
selectedEffects
required

Effect presets applied to this user’s spoken replies; empty for none

Array<string>
voiceName

The chosen voice id, or null for the deployment’s default voice

string
voices
required

Voices this user can choose from; empty when not available

Array<object>

One voice the user can choose for spoken replies

object
id
required

Voice id to send as voiceName, e.g. aura-2-phoebe-en

string
label
required

Name to show for the voice

string