Skip to navigation

Stemmen weergeven

Haalt een lijst op van alle beschikbare stemmen voor een gebruiker, met zoeken, filtering en paginering.

Headers

xi-api-keystringOptional

Query parameters

next_page_tokenstring or nullOptional

Het volgende paginatoken dat voor paginering moet worden gebruikt. Geretourneerd door de vorige request. Gebruik dit samen met de vlag has_more voor betrouwbare paginering.

page_sizeintegerOptionalDefaults to 10

Het maximale aantal stemmen dat moet worden geretourneerd. Mag niet hoger zijn dan 100; standaard is 10. Pagina 0 kan meer stemmen bevatten doordat standaardstemmen zijn opgenomen.

searchstring or nullOptional
Zoekterm om stemmen op te filteren. Zoekt in naam, beschrijving, labels en categorie.
sortstring or nullOptional

Op welk veld moet worden gesorteerd: ‘created_at_unix’ of ‘name’. ‘created_at_unix’ is mogelijk niet beschikbaar voor oudere stemmen.

sort_directionstring or nullOptional

In welke richting de stemmen moeten worden gesorteerd: ‘asc’ of ‘desc’.

voice_typestring or nullOptional

Type stem waarop moet worden gefilterd. Een van ‘personal’, ‘community’, ‘default’, ‘workspace’, ‘non-default’, ‘non-community’, ‘saved’. ‘non-default’ is gelijk aan alles behalve ‘default’. ‘non-community’ is gelijk aan de combinatie van ‘personal’ en ‘workspace’ (exclusief bibliotheekkopieën). ‘saved’ is gelijk aan non-default, maar omvat standaardstemmen als ze aan een collectie zijn toegevoegd.

categorystring or nullOptional
Categorie van de stem waarop moet worden gefilterd. Een van 'premade', 'cloned', 'generated', 'professional'
fine_tuning_statestring or nullOptional

Status van de finetuning van de stem waarop gefilterd moet worden. Alleen van toepassing op professionele stemklonen. Een van de volgende waarden: ‘draft’, ‘not_verified’, ‘not_started’, ‘queued’, ‘fine_tuning’, ‘fine_tuned’, ‘failed’, ‘delayed’

collection_idstring or nullOptional

Collectie-ID waarop stemmen moeten worden gefilterd.

genderstring or nullOptional
Geslacht gebruikt voor filtering, op basis van het label 'gender' van de stem.
agestring or nullOptional
Leeftijd gebruikt voor filtering, op basis van het label 'age' van de stem.
languagelist of strings or nullOptional
Talen die worden gebruikt voor filtering, op basis van het label 'language' van de stem. Stemmen die overeenkomen met een van de opgegeven talen worden geretourneerd.
accentstring or nullOptional
Accent dat wordt gebruikt voor filtering, op basis van het label 'accent' van de stem.
use_caseslist of strings or nullOptional

Use cases die worden gebruikt voor filtering, op basis van het label ‘use_case’ van de stem. Stemmen die overeenkomen met een van de opgegeven use cases worden teruggegeven.

min_notice_period_daysinteger or nullOptional
Filter op stemmen waarvan de kennisgevingstermijn voor delen ten minste het opgegeven aantal dagen is.
include_custom_ratesboolean or nullOptional
Of stemmen met een aangepast deeltarief moeten worden opgenomen. Standaard worden deze opgenomen.
include_live_moderatedboolean or nullOptional
Of stemmen waarvoor live moderatie is ingeschakeld moeten worden opgenomen. Standaard worden deze opgenomen.
high_qualityboolean or nullOptional

Wanneer true, retourneer je alleen stemmen van studiokwaliteit (stemmen met de categorie ‘high_quality’).

include_total_countbooleanOptionalDefaults to true

Of het totale aantal gevonden stemmen in de response moet worden opgenomen. LET OP: De waarde total_count is een live momentopname en kan tussen requests veranderen wanneer gebruikers stemmen maken, wijzigen of verwijderen. Gebruik voor paginering in plaats daarvan de vlag has_more. Schakel dit alleen in als je het totale aantal echt nodig hebt, bijvoorbeeld voor weergave, omdat dit prestaties kost.

voice_idslist of strings or nullOptional

Stem-ID’s om op te zoeken. Maximaal 100 stem-ID’s.

Response

Geslaagde response
voiceslist of objects
De lijst met stemmen die overeenkomen met de query.
has_moreboolean

Geeft aan of er op volgende pagina’s meer stemmen beschikbaar zijn. Gebruik deze vlag (en next_page_token) voor betrouwbare paginering in plaats van op total_count te vertrouwen.

total_countinteger

Het totale aantal stemmen dat overeenkomt met de query. Deze waarde is een live momentopname van de huidige status van de database en kan tussen requests veranderen wanneer gebruikers stemmen maken, wijzigen of verwijderen. Gebruik voor betrouwbare paginering de vlag has_more in plaats van op deze waarde te vertrouwen. Vraag dit veld alleen op wanneer je het totale aantal daadwerkelijk nodig hebt, bijvoorbeeld voor weergave, omdat de berekening ervan performancekosten met zich meebrengt.

next_page_tokenstring or nullOptional
Token om de volgende resultatenpagina op te halen. Geef deze waarde door aan de volgende request om door te gaan met paginering. Null als er geen verdere resultaten zijn.

Errors

422
Unprocessable Entity Error