Pular para o conteúdo principal

​
Visão Geral

A plataforma oferece APIs REST completas para integração, automação e desenvolvimento. Cada serviço da plataforma possui sua própria API documentada com especificações OpenAPI (Swagger). O que você vai encontrar aqui:
  • Documentação completa de todas as APIs disponíveis
  • Especificações OpenAPI para cada serviço
  • Exemplos de uso e integração
  • Guias de autenticação e autorização

​
APIs Disponíveis

A plataforma é composta por múltiplos microserviços, cada um com sua própria API:

​
Serviços de Aplicação

EvoAI Core Service
  • Gerenciamento de agentes de IA
  • Custom Tools e MCP (Model Context Protocol)
  • Sincronização com Evolution bots
  • Base URL: https://api.evoai.app
EvoAI CRM
  • Gerenciamento de conversas e mensagens
  • CRUD de contatos e agentes
  • Configuração de inboxes e canais
  • Base URL: https://api.evoai.app
EvoAuth Service
  • Autenticação e autorização
  • Multi-Factor Authentication (MFA)
  • Role-Based Access Control (RBAC)
  • Base URL: https://api.evoai.app
EvoAI Campaign
  • Criação e gerenciamento de campanhas
  • Segmentação de contatos
  • Automações e workflows
  • Base URL: https://api.evoai.app
EvoAI Processor
  • Processamento assíncrono de agentes
  • Execução de workflows de IA
  • Gerenciamento de filas
  • Base URL: https://api.evoai.app
EvoAI Knowledge
  • Upload e gerenciamento de documentos
  • Busca semântica
  • RAG (Retrieval-Augmented Generation)
  • Base URL: https://api.evoai.app

​
Serviços de Infraestrutura Evolution

Evolution API
  • Gerenciamento de instâncias WhatsApp
  • Envio e recebimento de mensagens
  • Integrações com chatbots
  • Base URL: https://api.evoai.app
Evolution Go
  • Gateway de alta performance
  • Processamento concorrente
  • Base URL: https://api.evoai.app

​
Base URL

Todos os serviços utilizam a mesma Base URL:
  • Base URL: https://api.evoai.app

​
OpenAPI / Swagger

Todas as APIs possuem especificações OpenAPI completas em formato YAML. Você pode importar essas especificações em ferramentas como Postman, Insomnia, ou gerar SDKs automaticamente.

​
Especificações Disponíveis

​
Serviços de Aplicação

​
Serviços de Infraestrutura Evolution

​
Autenticação

O padrão principal de autenticação nas APIs EvoAI é API Access Token (UUID) enviado no header api_access_token. Para obter credenciais e entender os detalhes completos de autenticação, consulte o guia dedicado: Guia Completo de Autenticação Exemplo rápido: 
curl -X GET https://api.evoai.app/api/v1/agents \
  -H "api_access_token: <SEU_TOKEN_UUID>" \
  -H "Content-Type: application/json"

​
Como Usar Esta Documentação

  • Introdução (esta página) - Visão geral das APIs e como começar
  • Autenticação - Guia completo de API Access Token e multi-tenant
  • Especificações OpenAPI - Documentação interativa de cada serviço (veja seção acima)

​
Especificações OpenAPI

Cada API possui uma especificação OpenAPI completa em formato YAML. Você pode:
  • Importar no Postman, Insomnia ou outras ferramentas
  • Gerar clientes SDK automaticamente usando openapi-generator
  • Visualizar interativamente usando Swagger UI

​
Exemplos de Requisições

Cada endpoint inclui exemplos de requisições e respostas com:
  • Códigos de status HTTP esperados
  • Estrutura de payloads de requisição
  • Formato de respostas JSON

​
Códigos de Status HTTP

Todas as APIs seguem padrões consistentes: Códigos de Sucesso:
  • 200 - OK (requisição bem-sucedida)
  • 201 - Created (recurso criado com sucesso)
Códigos de Erro:
  • 400 - Bad Request (dados inválidos)
  • 401 - Unauthorized (token inválido ou ausente)
  • 403 - Forbidden (sem permissão)
  • 404 - Not Found (recurso não encontrado)
  • 500 - Internal Server Error (erro do servidor)
  • 522 - Connection Timed Out (timeout na conexão)

​
Quick Start

​
Exemplo: Listar Agentes IA

curl -X GET https://api.evoai.app/api/v1/agents \
  -H "api_access_token: <SEU_TOKEN_UUID>" \
  -H "Content-Type: application/json"

​
Exemplo: Criar um Agente IA

curl -X POST https://api.evoai.app/api/v1/agents \
  -H "api_access_token: <SEU_TOKEN_UUID>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Meu Agente IA",
    "type": "llm",
    "model": "gpt-4",
    "prompt": "Você é um assistente útil.",
    "temperature": 0.7
  }'

​
Convenções

​
Formato de Data

Todas as APIs usam formato ISO 8601: 
2026-01-26T10:30:00Z

​
Paginação

APIs que retornam listas suportam paginação: 
GET /api/v1/agents?page=1&pageSize=10

​
Filtros e Busca

Muitas APIs suportam filtros via query parameters: 
GET /api/v1/agents?status=active&type=llm

​
Ferramentas Recomendadas

  • Postman - Coleção de APIs e testes
  • Insomnia - Cliente REST alternativo
  • Swagger UI - Visualização interativa das APIs
  • OpenAPI Generator - Geração automática de SDKs
  • curl - Testes rápidos via linha de comando

​
Próximos Passos

  1. Escolha a API que você precisa usar
  2. Consulte a especificação OpenAPI correspondente
  3. Configure autenticação obtendo seu API Access Token
  4. Comece a integrar usando os exemplos fornecidos

​
FAQ

​
Como obtenho credenciais de API?

O API Access Token (UUID) pode ser obtido através do painel de configurações do usuário ou administrador. Consulte o guia completo de autenticação para detalhes.

​
Posso usar as APIs em produção?

Sim, todas as APIs são estáveis e prontas para produção. Certifique-se de usar HTTPS e gerenciar seus tokens de forma segura.

​
As APIs suportam rate limiting?

Sim, a maioria das APIs implementa rate limiting. Consulte a documentação específica de cada API para limites detalhados.

​
Como reporto problemas ou sugiro melhorias?

Abra uma issue no GitHub ou entre em contato através do email de suporte.
Pronto para começar?
  1. Configure a autenticação para obter seu API Access Token
  2. Consulte os exemplos de uso abaixo ou nos guias específicos de integração