ElevenAPIVoices

Lister les voix

Récupère la liste de toutes les voix disponibles pour un utilisateur, avec recherche, filtrage et pagination.

En-têtes

xi-api-keystringOptionnel

Paramètres de requête

next_page_tokenstring or nullOptionnel

Le jeton de page suivant à utiliser pour la pagination. Renvoyé par la requête précédente. Utilisez-le avec l’indicateur has_more pour une pagination fiable.

page_sizeintegerOptionnelPar défaut 10

Nombre maximal de voix à renvoyer. Ne peut pas dépasser 100 ; 10 par défaut. La page 0 peut inclure davantage de voix en raison de l’inclusion des voix par défaut.

searchstring or nullOptionnel

Terme de recherche pour filtrer les voix. Recherche dans le nom, la description, les libellés et la catégorie.

sortstring or nullOptionnel

Indique le champ de tri, soit « created_at_unix », soit « name ». « created_at_unix » peut ne pas être disponible pour les anciennes voix.

sort_directionstring or nullOptionnel

Indique le sens de tri des voix : « asc » ou « desc ».

voice_typestring or nullOptionnel
Type de voix à utiliser pour le filtrage. L’une des valeurs suivantes : « personal », « community », « default », « workspace », « non-default », « non-community », « saved ». « non-default » correspond à toutes les valeurs sauf « default ». « non-community » correspond à « personal » et « workspace » combinées, à l’exclusion des copies de la bibliothèque. « saved » correspond à « non-default », mais inclut les voix par défaut lorsqu’elles ont été ajoutées à une collection.
categorystring or nullOptionnel

Catégorie de voix selon laquelle filtrer. L’une des valeurs suivantes : « premade », « cloned », « generated », « professional ».

fine_tuning_statestring or nullOptionnel

State of the voice’s fine tuning to filter by. Applicable only to professional voices clones. One of ‘draft’, ‘not_verified’, ‘not_started’, ‘queued’, ‘fine_tuning’, ‘fine_tuned’, ‘failed’, ‘delayed’

collection_idstring or nullOptionnel
ID de collection selon lequel filtrer les voix.
genderstring or nullOptionnel

Genre utilisé pour le filtrage, selon le libellé ‘gender’ de la voix.

agestring or nullOptionnel

Âge utilisé pour le filtrage, selon le libellé « age » de la voix.

languagelist of strings or nullOptionnel

Langues utilisées pour le filtrage, selon le libellé « language » de la voix. Les voix correspondant à l’une des langues indiquées sont renvoyées.

accentstring or nullOptionnel

Accent utilisé pour le filtrage, selon l’étiquette « accent » de la voix.

use_caseslist of strings or nullOptionnel

Cas d’utilisation servant au filtrage, selon le libellé « use_case » de la voix. Les voix correspondant à l’un des cas d’utilisation indiqués sont renvoyées.

min_notice_period_daysinteger or nullOptionnel

Filtrer les voix dont le délai de préavis de partage est au moins égal au nombre de jours indiqué.

include_custom_ratesboolean or nullOptionnel

Indique s’il faut inclure les voix avec un tarif de partage personnalisé. Elles sont incluses par défaut.

include_live_moderatedboolean or nullOptionnel

Indique s’il faut inclure les voix pour lesquelles la modération en direct est activée. Elles sont incluses par défaut.

high_qualityboolean or nullOptionnel

Lorsque la valeur est true, renvoie uniquement les voix de qualité studio, dont la catégorie est « high_quality ».

include_total_countbooleanOptionnelPar défaut true
Indique s'il faut inclure dans la réponse le nombre total de voix trouvées. REMARQUE : la valeur total_count est un instantané en temps réel et peut changer entre les requêtes lorsque des utilisateurs créent, modifient ou suppriment des voix. Pour la pagination, utilisez plutôt l'indicateur has_more. Activez cette option uniquement si vous avez réellement besoin du nombre total, par exemple à des fins d'affichage, car elle a un coût en performances.
voice_idslist of strings or nullOptionnel

ID de voix à rechercher. Maximum 100 ID de voix.

Réponse

Réponse réussie

voiceslist of objects

La liste des voix correspondant à la requête.

has_moreboolean

Indique si d’autres voix sont disponibles dans les pages suivantes. Utilisez cet indicateur, ainsi que next_page_token, pour une pagination fiable au lieu de vous fier à total_count.

total_countinteger

Le nombre total de voix correspondant à la requête. Cette valeur est un instantané en temps réel qui reflète l’état actuel de la base de données et peut varier entre les requêtes à mesure que les utilisateurs créent, modifient ou suppriment des voix. Pour une pagination fiable, utilisez l’indicateur has_more plutôt que de vous fier à cette valeur. Ne demandez ce champ que si vous avez réellement besoin du nombre total, par exemple à des fins d’affichage, car son calcul entraîne un coût de performance.

next_page_tokenstring or nullOptionnel

Jeton permettant de récupérer la page de résultats suivante. Transmettez cette valeur dans la requête suivante pour poursuivre la pagination. Null s’il n’y a plus de résultats.

Erreurs

422
Unprocessable Entity Error