ElevenAPIVoices

Listar voces

Obtiene una lista de todas las voces disponibles para un usuario, con búsqueda, filtrado y paginación.

Encabezados

xi-api-keystringOpcional

Parámetros de consulta

next_page_tokenstring or nullOpcional

El siguiente token de página que se debe usar para la paginación. Se devuelve en la solicitud anterior. Úsalo junto con la marca has_more para una paginación fiable.

page_sizeintegerOpcionalValor predeterminado: 10

Número máximo de voces que se devolverán. No puede superar 100; el valor predeterminado es 10. La página 0 puede incluir más voces debido a la inclusión de voces predeterminadas.

searchstring or nullOpcional

Término de búsqueda para filtrar voces. Busca en el nombre, la descripción, las etiquetas y la categoría.

sortstring or nullOpcional

Por qué campo ordenar: ‘created_at_unix’ o ‘name’. Puede que ‘created_at_unix’ no esté disponible para voces antiguas.

sort_directionstring or nullOpcional

En qué dirección ordenar las voces: ‘asc’ o ‘desc’.

voice_typestring or nullOpcional
Tipo de voz por el que filtrar. Uno de los siguientes: 'personal', 'community', 'default', 'workspace', 'non-default', 'non-community', 'saved'. 'non-default' equivale a todos excepto 'default'. 'non-community' equivale a la combinación de 'personal' y 'workspace' (excluye las copias de la biblioteca). 'saved' equivale a non-default, pero incluye voces predeterminadas si se han añadido a una colección.
categorystring or nullOpcional

Categoría de voz por la que filtrar. Una de estas: ‘premade’, ‘cloned’, ‘generated’, ‘professional’

fine_tuning_statestring or nullOpcional

Estado del ajuste fino de la voz por el que filtrar. Solo aplicable a clones de voz profesionales. Uno de: ‘draft’, ‘not_verified’, ‘not_started’, ‘queued’, ‘fine_tuning’, ‘fine_tuned’, ‘failed’, ‘delayed’.

collection_idstring or nullOpcional

ID de colección por el que filtrar voces.

genderstring or nullOpcional

Género utilizado para filtrar, según la etiqueta ‘gender’ de la voz.

agestring or nullOpcional

Edad usada para filtrar, según la etiqueta ‘age’ de la voz.

languagelist of strings or nullOpcional

Idiomas utilizados para filtrar, según la etiqueta ‘language’ de la voz. Se devuelven las voces que coincidan con cualquiera de los idiomas indicados.

accentstring or nullOpcional

Acento utilizado para filtrar, según la etiqueta ‘accent’ de la voz.

use_caseslist of strings or nullOpcional

Casos de uso utilizados para filtrar, según la etiqueta ‘use_case’ de la voz. Se devuelven las voces que coincidan con cualquiera de los casos de uso indicados.

min_notice_period_daysinteger or nullOpcional

Filtra voces cuyo periodo de aviso para compartir sea de al menos el número de días indicado.

include_custom_ratesboolean or nullOpcional

Indica si se deben incluir voces que tengan una tarifa de compartición personalizada. De forma predeterminada, se incluyen.

include_live_moderatedboolean or nullOpcional

Indica si se deben incluir voces que tengan activada la moderación en directo. De forma predeterminada, se incluyen.

high_qualityboolean or nullOpcional

Cuando es true, devuelve solo voces de calidad de estudio (aquellas cuya categoría es ‘high_quality’).

include_total_countbooleanOpcionalValor predeterminado: true
Indica si se debe incluir en la respuesta el número total de voces encontradas. NOTA: El valor de total_count es una instantánea en tiempo real y puede cambiar entre solicitudes a medida que los usuarios crean, modifican o eliminan voces. Para la paginación, usa en su lugar la marca has_more. Actívalo solo cuando realmente necesites el recuento total (por ejemplo, para mostrarlo), ya que tiene un coste de rendimiento.
voice_idslist of strings or nullOpcional

ID de voz que buscar. Máximo: 100 ID de voz.

Respuesta

Respuesta correcta.
voiceslist of objects
La lista de voces que coinciden con la consulta.
has_moreboolean

Indica si hay más voces disponibles en las páginas siguientes. Usa esta marca, junto con next_page_token, para una paginación fiable en lugar de depender de total_count.

total_countinteger

El número total de voces que coinciden con la consulta. Este valor es una instantánea en tiempo real que refleja el estado actual de la base de datos y puede cambiar entre solicitudes a medida que usuarios crean, modifican o eliminan voces. Para una paginación fiable, utiliza la marca has_more en lugar de basarte en este valor. Solicita este campo solo cuando necesites realmente el recuento total (por ejemplo, para mostrarlo), ya que calcularlo supone un coste de rendimiento.

next_page_tokenstring or nullOpcional

Token para obtener la siguiente página de resultados. Pasa este valor en la siguiente solicitud para continuar la paginación. Es nulo si no hay más resultados.

Errores

422
Unprocessable Entity Error