Referência da API
REST. JSON. Sem ginástica.
A API da camada é o que você espera de uma API REST moderna: payloads JSON, autenticação por header, multi-tenant por design. Em produção desde 2025. Aqui em baixo, as portas de entrada, conferidas contra o gateway em 27/09/2026.
Endpoints principais.
POST/eventsIngestão de qualquer evento do tenant. O ponto no nome vira underscore, como em todo o resto da plataforma. O que vale para a série é o seu `client_ts`: sem ele, o evento entra pela hora em que chegou.
POST/metrics/ingestEnvio de métricas agregadas (counters, gauges). Atualiza KPIs em tempo real.
POST/assistantConsulta conversacional com dados reais do tenant. RAG + LLM com contexto multi-tenant. É o único recurso com teto aplicado: acima do limite do plano ele recusa, dizendo o motivo.
GET/people/profilesLista perfis ativos. Filtros por segmento, recência, churn risk, CLV.
GET/people/profiles/:id/insightsInsight individual: histórico, predições, próxima melhor ação.
GET/kpisKPIs do tenant. Reset diário automático. Filtros por janela temporal.
POST/rulesCriar regra. Schema: condição + ação + janela + canal.
GET/quotaUso contra o teto do seu plano, item a item. `current: null` quer dizer que aquele item não é medido, e não que ele está em zero.
GET/billing/subscriptionPlano e estado da assinatura. Leitura local: o webhook do Stripe reconcilia por evento, então ela não depende do Stripe estar de pé.
GET/billing/invoicesSuas faturas, com número, valor, vencimento e o link de pagamento. A cobrança é por fatura (cartão ou boleto), não por cartão salvo.
GET/billing/tiersO catálogo de planos: preço, o que cada um libera e os tetos que valem. É de onde as telas leem, para não haver duas respostas.
GET/settings/exportExporta as declarações do tenant (configuração, indicadores, regras, cadastro) e DIZ o que ficou de fora e por onde buscar.
Autenticação.
Três modos de autenticação dependendo do contexto.
X-SYNQ-TOKEN
SDK do navegador (token sdk_…) e chave de servidor
Authorization: Bearer
JWT do Cognito (app autenticado)
Exemplo: enviar evento.
POST https://api.synqi3.ai/events
Header: X-SYNQ-TOKEN: <sua-chave>
Content-Type: application/json
{
"type": "order_paid",
"user_id": "u_8421",
"amount_total": 234.50,
"channel": "store_app",
"ts": "2026-06-01T20:47:00Z"
}Resposta: 200 OK · evento entra na fila de regras assíncrona.