Menu da documentação

API da Nevox

Leve o atendente com IA e o conhecimento da sua empresa para dentro do seu app, site ou sistema.

A API da Nevox leva o mesmo agente que atende seus clientes no WhatsApp, no chat do site e nos outros canais para dentro do seu próprio sistema: app, área do cliente, painel administrativo ou ferramenta interna da equipe.

Você ensina o agente uma vez, no painel da Nevox ou pela API, e ele responde igual em todo lugar.

O que você pode fazer

RecursoPara quê
Widget autenticadoColocar o chat da Nevox no seu app com o usuário já identificado
ConversasMontar o chat com a sua própria interface e usar a Nevox como cérebro
Perguntas diretas (/ask)Consultar o conhecimento da empresa em telas internas, sem abrir um chat
Conhecimento e tabela de serviçosManter o que o agente sabe sempre sincronizado com o seu sistema
EnsinoCorrigir respostas e aprovar o que o agente aprende
AçõesPermitir que o agente consulte e atualize dados no seu sistema (ex.: próximas consultas, agendar, remarcar)
WebhooksReceber avisos em tempo real: passagem para humano, novo lead, agendamento pedido
Análise de visitantes e clientesMedir quem visita seu site, quem conversa, quem vira lead e quem converte

O que fica dentro da Nevox

Os canais WhatsApp, chat do site, SMS, email e voz por telefone são conectados e gerenciados no painel da Nevox. Você não precisa de API para eles. A API serve para levar o agente e o conhecimento para os seus sistemas.

Planos

A API está disponível nos planos Pro - 3 Agentes e Ultimate - 5 Agentes. No plano Starter - 1 Agente, a área de desenvolvedores aparece bloqueada no painel.

Pro - 3 AgentesUltimate - 5 Agentes
Chaves de API320
Requisições por minuto60300
Conversas pela APIContam na franquia do plano (900/mês)Contam na franquia do plano (1.600/mês)
Perguntas diretas (/ask) por mês1.00010.000
Endpoints de webhook320
Ações por agente530
Eventos de rastreamento enviados pelo servidor, por mês10.000100.000
Retenção dos dados de análise90 dias13 meses
Exportação de análise em CSV—Sim
Ambiente de testeSimSim

Você acompanha o consumo em Painel → Desenvolvedores → Uso ou pelo endpoint GET /v1/usage.

Conceitos

  • Agente: o atendente com IA que você criou na Nevox. Cada um tem um ID como agt_8f2k....
  • Contato: uma pessoa atendida (seu cliente). Você o identifica pelo seu próprio ID, o external_id.
  • Visitante: alguém que acessou seu site ou app e ainda pode não ter se identificado.
  • Conversa: uma troca de mensagens entre um contato ou visitante e o agente, em qualquer canal.
  • Conhecimento: tudo o que o agente sabe: documentos, perguntas frequentes, páginas do seu site, correções e a tabela de serviços.
  • Ação: um endpoint do seu sistema que o agente pode chamar.

Endereço da API

texto
https://api.nevox.ai/v1

Todas as requisições usam HTTPS e JSON. Datas seguem o padrão ISO 8601 em UTC (ex.: 2026-11-03T14:30:00Z). Valores monetários são inteiros em centavos (9700 = R$ 97,00).

Próximos passos

  1. Gere sua chave e faça a primeira chamada
  2. Entenda chaves, escopos e tokens de sessão
  3. Coloque o atendente dentro do seu app