Referência da API
Lista de vozes
Obter vozes disponíveis para TTS
POST
/api/v1/voices/
Retorna uma lista de todas as vozes que o usuário autenticado tem permissão para usar com a API de Texto para Fala.
Autenticação
Inclua sua chave de API no cabeçalho Authorization como Bearer YOUR_API_KEY.
Corpo da requisição
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| language | opcional | string | Idioma dos nomes das vozes e dos valores dos selos, por exemplo ar, fr ou zh-hans (também aceito como ?language= na URL). Uma voz sem texto nesse idioma aparece em inglês, assim como um código ausente ou não suportado. O cabeçalho de resposta Content-Language informa o idioma usado. |
| engine | opcional | string | Sua chave de API lista só as vozes do próprio tipo (padrão ou avançado, escolhido ao criar a chave). Se você enviar engine, ele deve corresponder ao tipo da chave. |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| voice_id | inteiro | Identificador único da voz |
| voice_name | string | Nome de exibição da voz |
| voice_sample_url | string | URL do arquivo de áudio de amostra da voz |
| voice_fees | float | Taxa para usar esta voz (0 significa grátis) |
| voice_badges | object | Metadados adicionais da voz, ex.: idioma, gênero, idade, caso de uso |
| voice_engine | string | standard ou advanced. As vozes do mecanismo Padrão usam mode; as vozes do mecanismo Avançado usam context, setting, style e pace. Veja Motores e modos. |
Exemplo
curl "https://moknah.io/api/v1/voices/" \
-H "Authorization: Bearer YOUR_API_KEY"
import requests
response = requests.post(
"https://moknah.io/api/v1/voices/",
headers={"Authorization": "Bearer YOUR_API_KEY"}
)
voices = response.json()
for voice in voices:
print(voice["voice_name"], voice["voice_sample_url"])
const response = await fetch(
'https://moknah.io/api/v1/voices/',
{
headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
}
);
const voices = await response.json();
console.log(voices);
Exemplo de resposta
[
{
"voice_id": 1328,
"voice_name": "Adnan",
"voice_sample_url": "https://storage.moknah.io/media/voice_samples/Adnan.mp3",
"voice_fees": 0.0,
"voice_badges": {
"language": "Arabic",
"gender": "Male",
"age": "Young Adult",
"use_case": "Documentary, Audiobook, Article",
},
"voice_engine": "standard"
}
]
Suporte da API
Para dúvidas ou problemas relacionados à API, entre em contato conosco em api@moknah.io.