Início rápido

Gere uma chave, faça uma pergunta ao seu agente e ensine algo novo a ele em 5 minutos.

1. Gere uma chave de teste

No painel, vá em Desenvolvedores → Chaves de API → Gerar chave. Escolha o ambiente Teste e os escopos que precisar. Para este guia, marque agents:read, knowledge:read e knowledge:write.

A chave aparece uma única vez. Guarde num lugar seguro, como as variáveis de ambiente do seu servidor:

bash

export NEVOX_API_KEY="nvx_sk_test_..."

Importante: chaves secretas (nvx_sk_...) são só para o servidor. Nunca coloque uma chave secreta no código do navegador ou do app. Para o front, use o token de sessão.

2. Liste seus agentes

bash

curl https://api.nevox.ai/v1/agents \
  -H "Authorization: Bearer $NEVOX_API_KEY"

json

{
  "data": [
    {
      "id": "agt_8f2k1x",
      "name": "Atendimento Clínica",
      "language": "pt-BR",
      "status": "active",
      "created_at": "2026-10-02T13:10:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

3. Faça uma pergunta direta ao conhecimento

bash

curl https://api.nevox.ai/v1/agents/agt_8f2k1x/ask \
  -H "Authorization: Bearer $NEVOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "question": "Qual o valor da consulta de retorno?" }'

json

{
  "answered": true,
  "answer": "A consulta de retorno custa US$ 49,00 e precisa ser feita em até 30 dias após a primeira consulta.",
  "confidence": "high",
  "sources": [
    { "type": "service", "id": "svc_ret01", "title": "Consulta de retorno" }
  ]
}

Se o agente não souber, ele não inventa: devolve "answered": false e você decide o que fazer.

4. Ensine algo novo ao agente

bash

curl https://api.nevox.ai/v1/agents/agt_8f2k1x/knowledge \
  -H "Authorization: Bearer $NEVOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "faq",
    "question": "Vocês têm estacionamento?",
    "answer": "Sim, estacionamento gratuito no subsolo.",
    "external_id": "faq-estacionamento"
  }'

O agente passa a usar a resposta em todos os canais na mesma hora. Mandar de novo com o mesmo external_id atualiza o item em vez de duplicar.

5. Vá para produção

Quando estiver tudo certo, gere uma chave nvx_sk_live_... e troque a variável de ambiente. Chaves de teste respondem de verdade, mas não contam na franquia do plano e têm limite de 20 requisições por minuto.

Para onde ir agora

Conhecimento: itens, conhecimento interno e a tabela de serviços.
Autenticação: escopos e ambientes.
Conversas: o chat com a sua interface, com a Nevox como cérebro.
Webhooks: receba avisos de passagem para humano.
Erros, limites e convenções: o que fazer em cada erro.