Set the project's active voice

Set the project’s primary voice. The voice must already exist in the project’s voice library. This replaces the agent’s default voice; for multi-voice rotations, use the deployed voices endpoints instead.

PUT /v1/agents/{agentId}/voice

Set the project's active voice

cURL

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

200

{
  "voiceId": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

agentId · string · required

Body

application/json

Set the project's primary voice.

voiceId · string · required

Voice ID to set as the project's active voice

Response

200

application/json

Updated project voice

Confirmation of the newly set project voice.

voiceId · string · required

The voice ID now set as the project's active voice