Create custom voice

POST

Creates a Custom Voice that can be added to an EVI configuration.

Refer to our voices guide for details on creating a custom voice.

Request

This endpoint expects an object.
namestringRequired
The name of the Custom Voice. Maximum length of 75 characters. Will be converted to all-uppercase. (e.g., "sample voice" becomes "SAMPLE VOICE")
base_voiceenumRequired
Specifies the base voice used to create the Custom Voice.
parameter_model"20240715-4parameter"Required

The name of the parameter model used to define which attributes are used by the parameters field. Currently, only 20240715-4parameter is supported as the parameter model.

parametersobjectOptional

The specified attributes of a Custom Voice.

If no parameters are specified then all attributes will be set to their defaults, meaning no modfications will be made to the base voice.

Response

This endpoint returns an object.
idstring
Identifier for a Custom Voice. Formatted as a UUID.
versioninteger

Version number for a Custom Voice.

Custom Voices, Prompts, Configs, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.

Version numbers are integer values representing different iterations of the Custom Voice. Each update to the Custom Voice increments its version number.

namestring
The name of the Custom Voice. Maximum length of 75 characters.
created_onlong
Time at which the Custom Voice was created. Measured in seconds since the Unix epoch.
modified_onlong
Time at which the Custom Voice was last modified. Measured in seconds since the Unix epoch.
base_voiceenum
The base voice used to create the Custom Voice.
parameter_model"20240715-4parameter"

The name of the parameter model used to define which attributes are used by the parameters field. Currently, only 20240715-4parameter is supported as the parameter model.

parametersobject

The specified attributes of a Custom Voice. If a parameter’s value is 0 (default), it will not be included in the response.