Referência da API

Bem-vindo à Referência da API Talkover. Esta documentação fornece informações abrangentes sobre todos os endpoints disponíveis, métodos de autenticação e exemplos de integração.

Visão Geral

A API Talkover permite que você:

Crie e gerencie fluxos de chamadas - Projete caminhos de conversa inteligentes
Inicie e controle chamadas - Inicie conversas programaticamente
Monitore o status das chamadas - Acompanhe o progresso e resultados das chamadas em tempo real
Acesse análises de chamadas - Recupere métricas detalhadas de desempenho

Autenticação

Todos os endpoints da API requerem autenticação usando tokens Bearer. Inclua sua chave de API no cabeçalho Authorization:

Authorization: Bearer SUA_CHAVE_API

Mantenha sua chave de API segura e nunca a exponha em código do lado do cliente ou repositórios públicos.

URL Base

Todas as requisições da API devem ser feitas para:

https://app.talkover.ai/api/v1

Limites de taxa

Plano Padrão: 100 requisições por minuto
Plano Profissional: 1.000 requisições por minuto
Plano Enterprise: Limites personalizados

Cabeçalhos de limite de taxa são incluídos em todas as respostas da API para ajudá-lo a monitorar o uso.

Formato de Resposta

Todas as respostas da API são retornadas no formato JSON com a seguinte estrutura:

{
  "success": true,
  "data": {
    // Dados da resposta
  },
  "message": "Operação concluída com sucesso"
}

Tratamento de Erros

A API usa códigos de status HTTP padrão e retorna mensagens de erro detalhadas:

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "A chave de API fornecida é inválida",
    "details": {}
  }
}

Especificação OpenAPI

Baixar a especificação OpenAPI completa

Obtendo Ajuda

Se você precisar de assistência:

Documentação: Navegue pelos nossos guias e exemplos
Suporte: Entre em contato conosco em [email protected]

Primeiros Passos

Conceitos