Create or update a deployed voice

Add a new voice to the rotation, or update the probability of an existing deployed voice. Probabilities across all deployed voices must sum to 1.0.

PUT /v1/agents/{agentId}/deployed-voices

Create or update a deployed voice

cURL

curl --request PUT \
  --url https://api.us.poly.ai/v1/agents/{agentId}/deployed-voices \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "voiceId": "<string>",
  "probability": 0.5,
  "id": "<string>"
}
'

200

{
  "id": "<string>",
  "genaiProjectId": "<string>",
  "voiceId": "<string>",
  "probability": 123
}

Authorizations

x-api-key · string · header · required

Path Parameters

agentId · string · required

Body

application/json

Create or update a deployed voice. Omit id to create a new deployed voice; provide id to update an existing one.

voiceId · string · required

ID of the voice (from the voice library) to deploy

probability · number<float> · required

Traffic weight in the rotation, between 0.0 and 1.0. The sum of probabilities across all deployed voices must equal 1.0.

Required range: 0 <= x <= 1

id · string

Deployed voice ID. Omit to create a new entry; include to update an existing entry.

Response

200

application/json

The created or updated deployed voice

A single deployed voice in a project's voice rotation.

id · string · required

Deployed voice ID

genaiProjectId · string · required

Project ID this deployed voice belongs to

voiceId · string · required

ID of the underlying voice in the voice library

probability · number<float> · required

Traffic weight in the rotation, between 0.0 and 1.0