Skip to main content

​
Overview

The platform offers complete REST APIs for integration, automation, and development. Each service on the platform has its own API documented with OpenAPI (Swagger) specifications. What you’ll find here:
  • Complete documentation of all available APIs
  • OpenAPI specifications for each service
  • Usage and integration examples
  • Authentication and authorization guides

​
Available APIs

The platform is composed of multiple microservices, each with its own API:

​
Application Services

EvoAI Core Service
  • AI agent management
  • Custom Tools and MCP (Model Context Protocol)
  • Synchronization with Evolution bots
  • Base URL: https://api.evoai.app
EvoAI CRM
  • Conversation and message management
  • Contact and agent CRUD
  • Inbox and channel configuration
  • Base URL: https://api.evoai.app
EvoAuth Service
  • Authentication and authorization
  • Multi-Factor Authentication (MFA)
  • Role-Based Access Control (RBAC)
  • Base URL: https://api.evoai.app
EvoAI Campaign
  • Campaign creation and management
  • Contact segmentation
  • Automations and workflows
  • Base URL: https://api.evoai.app
EvoAI Processor
  • Asynchronous agent processing
  • AI workflow execution
  • Queue management
  • Base URL: https://api.evoai.app
EvoAI Knowledge
  • Document upload and management
  • Semantic search
  • RAG (Retrieval-Augmented Generation)
  • Base URL: https://api.evoai.app

​
Evolution Infrastructure Services

Evolution API
  • WhatsApp instance management
  • Message sending and receiving
  • Chatbot integrations
  • Base URL: https://api.evoai.app
Evolution Go
  • High-performance gateway
  • Concurrent processing
  • Base URL: https://api.evoai.app

​
Base URL

All services use the same Base URL:
  • Base URL: https://api.evoai.app

​
OpenAPI / Swagger

All APIs have complete OpenAPI specifications in YAML format. You can import these specifications into tools like Postman, Insomnia, or automatically generate SDKs.

​
Available Specifications

​
Application Services

​
Evolution Infrastructure Services

​
Authentication

The main authentication standard in EvoAI APIs is API Access Token (UUID) sent in the api_access_token header. To obtain credentials and understand the complete authentication details, consult the dedicated guide: Complete Authentication Guide Quick example:

​
How to Use This Documentation

  • Introduction (this page) - Overview of APIs and how to get started
  • Authentication - Complete guide to API Access Token and multi-tenant
  • OpenAPI Specifications - Interactive documentation for each service (see section above)

​
OpenAPI Specifications

Each API has a complete OpenAPI specification in YAML format. You can:
  • Import into Postman, Insomnia, or other tools
  • Automatically generate SDK clients using openapi-generator
  • View interactively using Swagger UI

​
Request Examples

Each endpoint includes request and response examples with:
  • Expected HTTP status codes
  • Request payload structure
  • JSON response format

​
HTTP Status Codes

All APIs follow consistent patterns: Success Codes:
  • 200 - OK (successful request)
  • 201 - Created (resource created successfully)
Error Codes:
  • 400 - Bad Request (invalid data)
  • 401 - Unauthorized (invalid or missing token)
  • 403 - Forbidden (no permission)
  • 404 - Not Found (resource not found)
  • 500 - Internal Server Error (server error)
  • 522 - Connection Timed Out (connection timeout)

​
Quick Start

​
Example: List AI Agents

​
Example: Create an AI Agent

​
Conventions

​
Date Format

All APIs use ISO 8601 format:

​
Pagination

APIs that return lists support pagination:
Many APIs support filters via query parameters:
  • Postman - API collection and testing
  • Insomnia - Alternative REST client
  • Swagger UI - Interactive API visualization
  • OpenAPI Generator - Automatic SDK generation
  • curl - Quick command-line testing

​
Next Steps

  1. Choose the API you need to use
  2. Consult the corresponding OpenAPI specification
  3. Configure authentication by obtaining your API Access Token
  4. Start integrating using the provided examples

​
FAQ

​
How do I obtain API credentials?

The API Access Token (UUID) can be obtained through the user or administrator settings panel. Consult the complete authentication guide for details.

​
Can I use the APIs in production?

Yes, all APIs are stable and production-ready. Make sure to use HTTPS and manage your tokens securely.

​
Do the APIs support rate limiting?

Yes, most APIs implement rate limiting. Consult the specific documentation for each API for detailed limits.

​
How do I report issues or suggest improvements?

Open an issue on GitHub or contact support via email.
Ready to get started?
  1. Configure authentication to obtain your API Access Token
  2. Explore the OpenAPI specifications for each service
  3. Consult the usage examples below or in specific integration guides