🔗 AI Tools API Documentation

RESTful APIs para integração com ferramentas de automação como n8n, Zapier e Make

Base URL: https://ai-tools.carraes.dev/api

🚀 Quick Start

Autenticação

Todas as APIs são públicas e não requerem autenticação.

⚠️ Importante: A API SQL requer autorização especial (apenas emails @zapsign.com.br)

Formato de Resposta

{
  "success": true,
  "data": {
    // Response data
  }
}
🏷️

Comment Categorization API

Analise e categorize automaticamente feedback de clientes

Endpoint

POST
/api/comments

Request Body

{
  "comments": [
    "O produto é excelente!",
    "Está com bug na tela de login",
    "Poderiam adicionar modo escuro?"
  ]
}

Categorias

😊 positive 😞 negative 😐 neutral 💡 feature_request 🐛 bug_report 🚨 urgent

Response

{
  "success": true,
  "data": {
    "categories": [
      {
        "text": "O produto é excelente!",
        "category": "positive",
        "confidence": 0.95,
        "sentiment_score": 0.8,
        "reasoning": "Elogio direto ao produto"
      }
    ],
    "summary": {
      "total_comments": 3,
      "positive_count": 1,
      "negative_count": 1,
      "urgent_count": 0,
      "top_themes": ["produto", "interface"]
    }
  }
}

cURL Example

curl -X POST https://ai-tools.carraes.dev/api/comments \
  -H "Content-Type: application/json" \
  -d '{"comments":["Ótimo produto!"]}'
📧

Email Summarization API

Transforme emails longos e tickets em resumos claros e acionáveis

Endpoint

POST
/api/summarize

Request Body

{
  "content": "Email content here...",
  "summary_type": "all",
  "focus_on": ["action_items", "deadlines"]
}

Parâmetros

content: Conteúdo para resumir (obrigatório)
summary_type: "brief", "detailed" ou "all"
focus_on: Array com áreas de foco opcionais

Response

{
  "success": true,
  "data": {
    "brief_summary": "Resumo conciso...",
    "detailed_summary": "Resumo detalhado...",
    "key_points": ["Ponto 1", "Ponto 2"],
    "action_items": ["Ação 1", "Ação 2"],
    "participants": ["João", "Maria"],
    "priority": "urgent",
    "sentiment": "negative",
    "category": "support_ticket",
    "deadline_mentioned": "até 17h hoje"
  }
}

cURL Example

curl -X POST https://ai-tools.carraes.dev/api/summarize \
  -H "Content-Type: application/json" \
  -d '{"content":"Seu email aqui..."}'
🗃️

SQL Generation API

Transforme linguagem natural em consultas SQL

⚠️

Acesso Restrito

Esta API é restrita a usuários autorizados (@zapsign.com.br)

Endpoint

POST
/api/sql

Request Body

{
  "query": "Mostre os usuários ativos",
  "schema_type": "simple"
}

Schema Types

simple: Tabelas principais do ZapSign
complete: Schema completo com todas as tabelas

Response

{
  "success": true,
  "data": {
    "sql": "SELECT * FROM users WHERE status = 'active'",
    "explanation": "Esta consulta retorna todos os usuários ativos",
    "schema_used": "simple",
    "table_count": 1,
    "estimated_complexity": "low"
  }
}

Segurança

Apenas consultas SELECT são recomendadas. Operações como DELETE, DROP são bloqueadas.

🔧 Exemplos de Integração

🔷

n8n Integration

Node: HTTP Request
Method: POST
URL: https://ai-tools.carraes.dev/api/[endpoint]
Headers: Content-Type: application/json
Body: JSON com os dados necessários
💡 Ideal para automação de helpdesk e análise de feedback

Zapier Integration

App: Webhooks by Zapier
Action: POST
Payload Type: JSON
URL: https://ai-tools.carraes.dev/api/[endpoint]
💡 Perfeito para integração com Gmail, Slack e CRMs

❌ Tratamento de Erros

Códigos de Status

200 Sucesso
400 Dados inválidos
500 Erro interno

Formato de Erro

{
  "success": false,
  "error": "Error type",
  "message": "Detailed error message"
}