ElevenAPIVoices

Listar vozes

Obtém uma lista de todas as vozes disponíveis para um usuário, com pesquisa, filtros e paginação.

Cabeçalhos

xi-api-keystringOpcional

Parâmetros de consulta

next_page_tokenstring or nullOpcional

O próximo token de página a ser usado na paginação. Retornado pela solicitação anterior. Use-o em conjunto com a flag has_more para uma paginação confiável.

page_sizeintegerOpcionalPadrão é 10

Quantidade máxima de vozes a retornar. Não pode exceder 100; o padrão é 10. A página 0 pode incluir mais vozes devido à inclusão de vozes padrão.

searchstring or nullOpcional

Termo de pesquisa para filtrar vozes. Pesquisa em nome, descrição, rótulos e categoria.

sortstring or nullOpcional

Por qual campo ordenar: ‘created_at_unix’ ou ‘name’. ‘created_at_unix’ pode não estar disponível para vozes mais antigas.

sort_directionstring or nullOpcional

Em qual direção ordenar as vozes: ‘asc’ ou ‘desc’.

voice_typestring or nullOpcional
Tipo de voz pelo qual filtrar. Um entre 'personal', 'community', 'default', 'workspace', 'non-default', 'non-community' e 'saved'. 'non-default' equivale a todos, exceto 'default'. 'non-community' equivale a 'personal' e 'workspace' combinados (exclui cópias da biblioteca). 'saved' equivale a non-default, mas inclui vozes padrão caso tenham sido adicionadas a uma coleção.
categorystring or nullOpcional

Categoria da voz para filtrar. Uma de: ‘premade’, ‘cloned’, ‘generated’, ‘professional’

fine_tuning_statestring or nullOpcional

Estado do Finetune da voz para filtrar. Aplicável apenas a clones de voz profissionais. Um entre: ‘draft’, ‘not_verified’, ‘not_started’, ‘queued’, ‘fine_tuning’, ‘fine_tuned’, ‘failed’, ‘delayed’.

collection_idstring or nullOpcional

ID da coleção para filtrar vozes.

genderstring or nullOpcional

Gênero usado para filtragem, com base no rótulo ‘gender’ da voz.

agestring or nullOpcional

Idade usada para filtragem, com base no rótulo ‘age’ da voz.

languagelist of strings or nullOpcional

Idiomas usados para filtragem, com base no rótulo ‘language’ da voz. São retornadas vozes que correspondem a qualquer um dos idiomas informados.

accentstring or nullOpcional

Sotaque usado para filtragem, com base no rótulo ‘accent’ da voz.

use_caseslist of strings or nullOpcional

Casos de uso para filtragem, com base no rótulo ‘use_case’ da voz. São retornadas as vozes que correspondem a qualquer um dos casos de uso fornecidos.

min_notice_period_daysinteger or nullOpcional

Filtre vozes cujo período de aviso de compartilhamento seja de pelo menos o número de dias informado.

include_custom_ratesboolean or nullOpcional

Indica se deve incluir vozes que têm uma taxa de compartilhamento personalizada. Por padrão, elas são incluídas.

include_live_moderatedboolean or nullOpcional

Indica se deve incluir vozes com moderação ao vivo ativada. Por padrão, elas são incluídas.

high_qualityboolean or nullOpcional

Quando true, retorna apenas vozes com qualidade de estúdio (aquelas cuja categoria é ‘high_quality’).

include_total_countbooleanOpcionalPadrão é true
Indica se deve incluir na resposta a contagem total de vozes encontradas. OBSERVAÇÃO: o valor de total_count é um retrato em tempo real e pode mudar entre solicitações à medida que os usuários criam, modificam ou excluem vozes. Para paginação, use a sinalização has_more. Ative esta opção apenas quando realmente precisar da contagem total, por exemplo, para exibição, pois ela afeta o desempenho.
voice_idslist of strings or nullOpcional

IDs de voz a serem pesquisados. Máximo de 100 IDs de voz.

Resposta

Resposta bem-sucedida

voiceslist of objects

A lista de vozes que correspondem à consulta.

has_moreboolean

Indica se há mais vozes disponíveis nas páginas seguintes. Use este sinalizador, junto com next_page_token, para uma paginação confiável, em vez de depender de total_count.

total_countinteger

A contagem total de vozes que correspondem à consulta. Esse valor é um retrato em tempo real que reflete o estado atual do banco de dados e pode mudar entre solicitações à medida que usuários criam, modificam ou excluem vozes. Para uma paginação confiável, use a flag has_more em vez de depender desse valor. Solicite esse campo apenas quando realmente precisar da contagem total, por exemplo, para exibição, pois calculá-lo tem um custo de desempenho.

next_page_tokenstring or nullOpcional

Token para recuperar a próxima página de resultados. Passe esse valor na próxima solicitação para continuar a paginação. Nulo se não houver mais resultados.

Erros

422
Unprocessable Entity Error