Stimmen auflisten

Ruft eine Liste aller verfügbaren Stimmen für einen Benutzer mit Suche, Filterung und Paginierung ab.

Header

xi-api-keystringOptional

Abfrageparameter

next_page_tokenstring or nullOptional

Das nächste Seitentoken für die Paginierung. Wird von der vorherigen Anfrage zurückgegeben. Verwenden Sie es zusammen mit dem Flag has_more für eine zuverlässige Paginierung.

page_sizeintegerOptionalStandardwert ist 10

Maximale Anzahl zurückzugebender Stimmen. Darf 100 nicht überschreiten, Standardwert ist 10. Seite 0 kann aufgrund enthaltener Standardstimmen mehr Stimmen enthalten.

searchstring or nullOptional
Suchbegriff zum Filtern von Stimmen. Durchsucht Name, Beschreibung, Labels und Kategorie.
sortstring or nullOptional

Nach welchem Feld sortiert werden soll: ‘created_at_unix’ oder ‘name’. ‘created_at_unix’ ist für ältere Stimmen möglicherweise nicht verfügbar.

sort_directionstring or nullOptional

In welcher Richtung die Stimmen sortiert werden sollen: ‘asc’ oder ‘desc’.

voice_typestring or nullOptional
Typ der Stimme, nach dem gefiltert wird. Einer von 'personal', 'community', 'default', 'workspace', 'non-default', 'non-community', 'saved'. 'non-default' entspricht allen außer 'default'. 'non-community' entspricht der Kombination aus 'personal' und 'workspace' und schließt Kopien aus der Stimmbibliothek aus. 'saved' entspricht non-default, enthält aber Standardstimmen, wenn diese einer Sammlung hinzugefügt wurden.
categorystring or nullOptional

Kategorie der Stimme, nach der gefiltert wird. Eine von „premade“, „cloned“, „generated“, „professional“

fine_tuning_statestring or nullOptional

Status des Finetunings der Stimme, nach dem gefiltert wird. Gilt nur für professionelle Stimmklone. Einer von ‘draft’, ‘not_verified’, ‘not_started’, ‘queued’, ‘fine_tuning’, ‘fine_tuned’, ‘failed’, ‘delayed’

collection_idstring or nullOptional

Collection-ID, nach der Stimmen gefiltert werden.

genderstring or nullOptional

Zum Filtern verwendetes Geschlecht basierend auf dem ‘gender’-Label der Stimme.

agestring or nullOptional

Für die Filterung verwendetes Alter, basierend auf dem Label „age“ der Stimme.

languagelist of strings or nullOptional

Zum Filtern verwendete Sprachen basierend auf dem Label „language“ der Stimme. Stimmen, die einer der angegebenen Sprachen entsprechen, werden zurückgegeben.

accentstring or nullOptional

Akzent für die Filterung, basierend auf dem Label ‘accent’ der Stimme.

use_caseslist of strings or nullOptional

Für die Filterung verwendete Anwendungsfälle basierend auf dem Label ‘use_case’ der Stimme. Es werden Stimmen zurückgegeben, die einem der angegebenen Anwendungsfälle entsprechen.

min_notice_period_daysinteger or nullOptional

Auf Stimmen filtern, deren Kündigungsfrist für die Freigabe mindestens die angegebene Anzahl an Tagen beträgt.

include_custom_ratesboolean or nullOptional

Ob Stimmen mit einer benutzerdefinierten Freigaberate einbezogen werden sollen. Standardmäßig werden sie einbezogen.

include_live_moderatedboolean or nullOptional

Ob Stimmen mit aktivierter Live-Moderation einbezogen werden sollen. Standardmäßig werden sie einbezogen.

high_qualityboolean or nullOptional

Wenn true, werden nur Stimmen in Studioqualität zurückgegeben, deren Kategorie ‘high_quality’ ist.

include_total_countbooleanOptionalStandardwert ist true
Ob die Gesamtzahl der gefundenen Stimmen in die Antwort aufgenommen werden soll. HINWEIS: Der Wert total_count ist eine Live-Aufnahme und kann sich zwischen Anfragen ändern, wenn Nutzer Stimmen erstellen, ändern oder löschen. Verwenden Sie für die Paginierung stattdessen das Flag has_more. Aktivieren Sie dies nur, wenn Sie die Gesamtzahl tatsächlich benötigen, z. B. zur Anzeige, da dies die Performance beeinträchtigt.
voice_idslist of strings or nullOptional

Stimmen-IDs, nach denen gesucht wird. Maximal 100 Stimmen-IDs.

Antwort

Erfolgreiche Antwort
voiceslist of objects
Die Liste der Stimmen, die der Abfrage entsprechen.
has_moreboolean

Gibt an, ob auf nachfolgenden Seiten weitere Stimmen verfügbar sind. Verwenden Sie dieses Flag (und next_page_token) für eine zuverlässige Paginierung, statt sich auf total_count zu verlassen.

total_countinteger

Die Gesamtzahl der Stimmen, die der Abfrage entsprechen. Dieser Wert ist eine Live-Aufnahme des aktuellen Datenbankzustands und kann sich zwischen Anfragen ändern, wenn Nutzer Stimmen erstellen, ändern oder löschen. Verwenden Sie für zuverlässige Paginierung das Flag has_more, statt sich auf diesen Wert zu verlassen. Fragen Sie dieses Feld nur ab, wenn Sie die Gesamtzahl tatsächlich benötigen, z. B. zur Anzeige, da die Berechnung die Leistung beeinträchtigt.

next_page_tokenstring or nullOptional

Token zum Abrufen der nächsten Ergebnisseite. Übergeben Sie diesen Wert mit der nächsten Anfrage, um die Seitennummerierung fortzusetzen. Null, wenn keine weiteren Ergebnisse vorhanden sind.

Fehler

422
Unprocessable Entity Error