ENDPOINTSVoices

List similar voices

Returns a list of shared voices similar to the provided audio sample. If neither similarity_threshold nor top_k is provided, we will apply default values.

Headers

xi-api-keystringOptional

Request

This endpoint expects a multipart form containing an optional file.
audio_filefileOptional
similarity_thresholddoubleOptional
Threshold for voice similarity between provided sample and library voices. Values range from 0 to 2. The smaller the value the more similar voices will be returned.
top_kintegerOptional

Number of most similar voices to return. If similarity_threshold is provided, less than this number of voices may be returned. Values range from 1 to 100.

Response

Successful Response
voiceslist of objects
The list of shared voices
has_moreboolean
Whether there are more shared voices in subsequent pages.
last_sort_idstringOptional

Errors