Vai alla navigazione
ElevenAPIVoices

Elenca voci

Ottiene un elenco di tutte le voci disponibili per un utente, con ricerca, filtri e paginazione.

Header

xi-api-keystringOpzionale

Parametri di query

next_page_tokenstring or nullOpzionale

Il token della pagina successiva da usare per la paginazione. Restituito dalla richiesta precedente. Usalo insieme al flag has_more per una paginazione affidabile.

page_sizeintegerOpzionalePredefinito a 10

Numero massimo di voci da restituire. Non può superare 100; il valore predefinito è 10. La pagina 0 può includere più voci a causa dell'inclusione delle voci predefinite.

searchstring or nullOpzionale
Termine di ricerca per filtrare le voci. Cerca in nome, descrizione, etichette e categoria.
sortstring or nullOpzionale

Campo in base al quale ordinare: 'created_at_unix' o 'name'. 'created_at_unix' potrebbe non essere disponibile per le voci meno recenti.

sort_directionstring or nullOpzionale

Direzione in cui ordinare le voci: 'asc' o 'desc'.

voice_typestring or nullOpzionale

Tipo di voce in base al quale filtrare. Uno tra 'personal', 'community', 'default', 'workspace', 'non-default', 'non-community', 'saved'. 'non-default' equivale a tutti tranne 'default'. 'non-community' equivale alla combinazione di 'personal' e 'workspace' (esclude le copie della libreria). 'saved' equivale a non-default, ma include le voci predefinite se sono state aggiunte a una raccolta.

categorystring or nullOpzionale
Categoria della voce in base alla quale filtrare. Una tra 'premade', 'cloned', 'generated', 'professional'
fine_tuning_statestring or nullOpzionale

Stato del fine-tuning della voce in base al quale filtrare. Applicabile solo ai cloni vocali professionali. Uno tra 'draft', 'not_verified', 'not_started', 'queued', 'fine_tuning', 'fine_tuned', 'failed', 'delayed'

collection_idstring or nullOpzionale
ID della raccolta in base al quale filtrare le voci.
genderstring or nullOpzionale
Genere usato per il filtro, in base all'etichetta 'gender' della voce.
agestring or nullOpzionale

Età usata per il filtro, in base all'etichetta 'age' della voce.

languagelist of strings or nullOpzionale
Lingue usate per il filtro, in base all'etichetta 'language' della voce. Vengono restituite le voci corrispondenti a una qualsiasi delle lingue specificate.
accentstring or nullOpzionale
Accento usato per il filtro, in base all'etichetta 'accent' della voce.
use_caseslist of strings or nullOpzionale

Casi d'uso impiegati per il filtro, in base all'etichetta 'use_case' della voce. Vengono restituite le voci che corrispondono a uno qualsiasi dei casi d'uso indicati.

min_notice_period_daysinteger or nullOpzionale

Filtra le voci il cui periodo di preavviso per la condivisione è almeno pari al numero di giorni indicato.

include_custom_ratesboolean or nullOpzionale
Indica se includere le voci con una tariffa di condivisione personalizzata. Per impostazione predefinita, sono incluse.
include_live_moderatedboolean or nullOpzionale
Indica se includere le voci con la moderazione live abilitata. Per impostazione predefinita, sono incluse.
high_qualityboolean or nullOpzionale

Se true, restituisce solo voci di qualità da studio (quelle la cui categoria è 'high_quality').

include_total_countbooleanOpzionalePredefinito a true

Indica se includere nella risposta il conteggio totale delle voci trovate. NOTA: il valore total_count è uno snapshot in tempo reale e può cambiare tra le richieste quando gli utenti creano, modificano o eliminano voci. Per la paginazione, utilizza invece il flag has_more. Abilita questa opzione solo quando hai effettivamente bisogno del conteggio totale, ad esempio per la visualizzazione, poiché comporta un costo in termini di prestazioni.

voice_idslist of strings or nullOpzionale
ID delle voci in base a cui effettuare la ricerca. Massimo 100 ID voce.

Risposta

Risposta riuscita
voiceslist of objects
L'elenco delle voci corrispondenti alla query.
has_moreboolean

Indica se sono disponibili altre voci nelle pagine successive. Usa questo flag, insieme a next_page_token, per una paginazione affidabile anziché basarti su total_count.

total_countinteger

Il numero totale di voci corrispondenti alla query. Questo valore è uno snapshot in tempo reale che riflette lo stato attuale del database e può cambiare tra le richieste quando gli utenti creano, modificano o eliminano voci. Per una paginazione affidabile, usa il flag has_more invece di basarti su questo valore. Richiedi questo campo soltanto quando hai effettivamente bisogno del conteggio totale, ad esempio per visualizzarlo, poiché il suo calcolo comporta un costo in termini di prestazioni.

next_page_tokenstring or nullOpzionale
Token per recuperare la pagina successiva dei risultati. Passa questo valore alla richiesta successiva per continuare la paginazione. Null se non ci sono altri risultati.

Errori

422
Unprocessable Entity Error