This user's voice preferences, and whether voice is available at all in this deployment

GET

/api/v1/profile/voice

const url = 'http://localhost:11044/api/v1/profile/voice';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/profile/voice \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Authorizations

apiKeyAuth
basicAuth

Responses

200

*/*

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

required

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

string

label

required

Name to show for the voice

string