Kitta Audio Docs
Referência API
Back to site

Referência API

Referência de endpoint Kitta Audio Open API.

Referência API

O Kitta Audio Open API é a interface do lado do servidor para fluxos de trabalho de produção de áudio. Use-o quando seu produto precisar de conversão de texto em fala, fala em texto, gerenciamento de voz ou automação de sincronização labial sem depender do console da web.

URL base:

https://kittaai.com/api/open/v1

Autenticação:

Authorization: Bearer KITTA_API_KEY

Esquema legível por máquina:

GET /api/openapi.json

Superfícies públicas atuais

SuperfícieStatus atual de API no exteriorDocumentos
PerfilEndpoint público v1 para verificações de conta, nível, créditos e cotaPerfil
Texto para falaSincronização pública HTTP e endpoints de trabalho assíncronosSincronizar HTTP, Trabalhos assíncronos
TTS em tempo realA disponibilidade é controlada pela conta e lançamento do produtoTTS em tempo real
Fala para TextoPonto final de transcrição público HTTPFala para Texto
ASR em tempo realA disponibilidade é controlada pela conta e lançamento do produtoASR em tempo real
ImagensPágina de capacidade do produto; disponibilidade de endpoint público é orientada por esquemaImagens
VídeosPágina de capacidade do produto; disponibilidade de endpoint público é orientada por esquemaVídeos
Gerenciamento de vozAbra endpoints API para listar, criar e excluir modelos de vozGerenciamento de voz
Sincronização labialTerminais de trabalho assíncronos públicos para fluxos de trabalho de vídeo e áudio de origemSincronização labial
UsoOrientação de uso da conta; use perfil hoje e esquema para novos endpoints de usoUso

Modelo de solicitação

Todas as solicitações devem ser feitas no seu servidor. Os clientes do navegador e os aplicativos móveis devem chamar seu próprio back-end primeiro e, em seguida, seu back-end chama o Open API com a chave API.

curl https://kittaai.com/api/open/v1/profile \
  -H "Authorization: Bearer KITTA_API_KEY"

Use JSON para a maioria dos terminais. A criação de voz pode usar dados de formulário multiparte quando o provedor habilitado exigir áudio de referência. As respostas de áudio binárias são usadas pela sincronização TTS quando você solicita áudio direto em vez de metadados armazenados em cache.

Modelo de resposta

As respostas bem-sucedidas são específicas do endpoint. Os pontos de extremidade assíncronos retornam objetos de trabalho ou tarefa que seu aplicativo deve pesquisar até que um status de terminal seja alcançado. Os pontos finais de mídia de sincronização podem retornar dados binários ou metadados JSON dependendo das opções de solicitação.

Os erros usam um corpo JSON:

{
  "code": "invalid_request",
  "message": "The request payload is invalid.",
  "requestId": "req_xxx"
}

Registrar requestId quando estiver presente. É a maneira mais rápida de o suporte rastrear uma solicitação com falha.

Faturamento e créditos

Chamadas API abertas consomem créditos da conta ou cota API de acordo com o endpoint e modelo habilitado. Alguns endpoints cobram quando uma tarefa é aceita; outros cobram quando a geração de mídia é bem-sucedida. Sua integração deve exibir um estado claro de nova tentativa e não deve presumir que cada solicitação com falha custará créditos.

Para fluxos de trabalho sensíveis ao equilíbrio, chame Perfil antes de iniciar lotes grandes e após a conclusão de trabalhos importantes. Os trabalhos de longa duração também devem manter o ID da tarefa retornado para que você possa se recuperar das reinicializações do cliente sem criar trabalho duplicado.

Compatibilidade

Os caminhos Legacy Open API permanecem disponíveis durante a janela de compatibilidade, mas novas integrações devem usar /api/open/v1. O guia de migração lista substituições de caminhos conhecidos e ordem de implementação.

Os documentos estrangeiros usam intencionalmente seus próprios caminhos atuais. Se você estiver integrando o site global, siga os caminhos em https://kittaai.com/api/open/v1 e confirme novas superfícies com GET /api/openapi.json.