Endpoints

Referência completa dos endpoints da API.

Base URL

https://api.supersquad.com/v1

Agents

Listar agentes

http
GET /agents

Response:

json
{
  "data": [
    {
      "id": "agent_123",
      "name": "Assistente de Vendas",
      "status": "active"
    }
  ],
  "pagination": {
    "total": 10,
    "page": 1,
    "limit": 20
  }
}

Obter agente

http
GET /agents/:id

Criar agente

http
POST /agents

Body:

json
{
  "name": "Novo Agente",
  "instructions": "Você é um assistente...",
  "model": "gpt-4o-mini"
}

Atualizar agente

http
PATCH /agents/:id

Deletar agente

http
DELETE /agents/:id

Contacts

Listar contatos

http
GET /contacts

Obter contato

http
GET /contacts/:id

Criar contato

http
POST /contacts

Body:

json
{
  "name": "João Silva",
  "phone": "+5511999999999",
  "email": "joao@example.com"
}

Messages

Enviar mensagem

http
POST /messages

Body:

json
{
  "contactId": "contact_123",
  "channelId": "channel_456",
  "content": "Olá! Como posso ajudar?"
}

Listar mensagens

http
GET /threads/:threadId/messages

Threads

Listar threads

http
GET /threads

Obter thread

http
GET /threads/:id

Criar thread

http
POST /threads

Estatísticas NPS

Agrega respostas NPS registradas em threads (nps_created_at no intervalo).

http
GET /threads/stats/nps?workspaceId={uuid}&dateFrom={iso}&dateTo={iso}

Response:

json
{
  "promotores": 4,
  "neutros": 1,
  "detratores": 2,
  "total": 7,
  "npsScore": 29
}

Promotores: 9–10. Neutros: 7–8. Detratores: 0–6. npsScore é null sem respostas no período.