Conversas e mensagens
Crie conversas, envie mensagens e receba a resposta do agente de IA em streaming via SSE.
Desenvolvedores
Construa com a API da Cognizy.
API REST com streaming em tempo real (SSE), webhooks assinados e busca semântica. Tudo o que o painel faz, o seu código também pode fazer.
01 / Comece em minutos
Três passos até a primeira chamada.
01
Crie sua API key
No painel, acesse Configurações → Desenvolvedores e gere uma chave. Chaves de produção usam o prefixo cgz_live_; as de sandbox, cgz_test_. Disponível nos planos Professional e Enterprise.
api keys
cgz_live_9f2b41c7e8a3… # produção
cgz_test_5d81a0f34b92… # sandbox02
Autentique cada requisição
Envie a chave como Bearer token no header Authorization. A chave identifica sua organização automaticamente — você nunca precisa passar organizationId.
terminal
curl https://api.cognizy.ai/api/v1/public/conversations \
-H "Authorization: Bearer cgz_live_xxx"03
Faça a primeira chamada
Liste suas conversas para confirmar que está tudo funcionando. Todas as respostas são JSON, com paginação em data + meta.
response
{
"data": [
{
"id": "cmc1x…",
"status": "OPEN",
"channel": "WHATSAPP",
"contact": { "id": "cmc2y…", "name": "Maria Souza" },
"lastMessageAt": "2026-07-01T14:22:08.000Z"
}
],
"meta": { "page": 1, "limit": 25, "total": 128 }
}02 / Recursos
O que dá para construir.
Contatos e tags
Liste e atualize contatos, gerencie tags para segmentação e roteamento.
Knowledge base (RAG)
Gerencie bases de conhecimento e documentos; rode busca semântica na sua base.
Tarefas
Quadros, tarefas, checklists, etiquetas e comentários — automatize seu fluxo operacional.
Campanhas e analytics
Leia campanhas, resultados por variante e métricas agregadas do tenant.
Agendamento
Consulte páginas de agendamento e os compromissos marcados.
Webhooks
Receba eventos (mensagem, conversa, deal, pagamento) com assinatura HMAC-SHA256 e replay de entregas.
WhatsApp Send API
Envio direto de mensagens WhatsApp estilo Twilio, com fila, idempotência e status por webhook.
03 / Boas práticas
Feita para rodar em produção.
Rate limits transparentes
Limites por chave em janela deslizante. Respostas 429 incluem X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset e Retry-After.
Idempotência
Envie o header Idempotency-Key em escritas. Repetir a mesma chave devolve a mesma resposta por 24h — retry seguro em falha de rede.
Paginação previsível
Listas usam page/limit; streams ordenados por tempo usam cursor opaco com nextCursor e hasMore.
Erros consistentes
Todo erro segue '{' statusCode, code, message '}' — trate por code, não por texto.
Pronto para integrar?
Crie sua conta, gere a API key e faça a primeira chamada hoje.