Open-source REST API for WhatsApp and multi-channel messaging — part of the Evolution Foundation ecosystem.
Website · Documentation · Community · Support
Evolution API is a powerful, production-ready REST API for WhatsApp and multi-channel messaging. Originally focused on WhatsApp, it has grown into a comprehensive platform supporting multiple messaging providers and integrations.
Today, Evolution API supports both the Baileys-based WhatsApp Web API and the official WhatsApp Cloud API, plus integrations with Typebot, Chatwoot, Dify, OpenAI, RabbitMQ, Apache Kafka, Amazon SQS, Socket.io, Amazon S3 / MinIO, and more.
Evolution API began as a WhatsApp controller API based on CodeChat, which in turn implemented the Baileys library. We continue to acknowledge CodeChat for laying the groundwork.
Evolution API is one of the messaging engines maintained by Evolution Foundation. It is used as a WhatsApp provider by the Evo CRM Community and other projects in the ecosystem.
Evolution API supports multiple connection types to WhatsApp:
A free API based on WhatsApp Web, leveraging the Baileys library. Suitable for multi-service chats, service bots, and WhatsApp-integrated systems. Note: this method relies on the web version of WhatsApp and may have limitations compared to official APIs.
The official API provided by Meta. Designed for businesses with higher messaging volumes and stronger integration support, including end-to-end encryption, advanced analytics, and customer service tools. Requires compliance with Meta's policies and may incur per-message costs.
Evolution API integrates natively with many platforms:
- Typebot — conversational bots with trigger management
- Chatwoot — customer service platform
- RabbitMQ — event streaming via AMQP
- Apache Kafka — real-time event streaming and processing
- Amazon SQS — cloud-based message queuing
- Socket.io — real-time WebSocket events
- Dify — AI agent workflows
- OpenAI — AI capabilities including audio-to-text conversion
- Amazon S3 / MinIO — media file storage
- Node.js 20+
- PostgreSQL or MySQL
- Redis (recommended for caching)
git clone git@github.com:evolution-foundation/evolution-api.git
cd evolution-api
# Install dependencies
npm install
# Configure environment
cp .env.example .env
# Edit .env with your database, Redis, and API key# Set the database provider
export DATABASE_PROVIDER=postgresql # or mysql
# Generate Prisma client
npm run db:generate
# Deploy migrations
npm run db:deploy# Development with hot reload
npm run dev:server
# Production build and run
npm run build
npm run start:proddocker pull evoapicloud/evolution-api:latest
docker run -p 8080:8080 --env-file .env evoapicloud/evolution-api:latestThis fork also publishes an image to GitHub Container Registry after changes land on main:
services:
api:
image: ghcr.io/neup123/evolution-api:latest
restart: always
ports:
- "8080:8080"
env_file:
- .envThe image can be pulled directly with docker pull ghcr.io/neup123/evolution-api:latest.
If the GitHub package is private, authenticate once with a GitHub token that has read:packages permission.
This fork exposes typed Baileys 7 socket methods at
POST /baileys/<group>/<method>/:instanceName. Request bodies use named fields generated from the Baileys
TypeScript signatures. For example, communityParticipantsUpdate accepts:
{
"jid": "120363000000000000@g.us",
"participants": ["5511999999999@s.whatsapp.net"],
"action": "add"
}The legacy POST /baileys/<method>/:instanceName positional-argument route was removed in v3. Binary
arguments and results use { "$base64": "..." }. The live method registry is available at
GET /baileys/methods/:instanceName, and Swagger UI is served at /docs unless
SERVER_DISABLE_DOCS=true. The source specification is in docs/openapi.yaml, and the fork-specific
usage guide is in docs/README.md.
Evolution API is built with a multi-provider, event-driven architecture:
Client / CRM
↓
Evolution API
├── Channel Integrations (Baileys / Cloud API)
├── Chatbot Integrations (Typebot, Chatwoot, OpenAI, Dify, Flowise, N8N)
├── Event Integrations (WebSocket, RabbitMQ, SQS, NATS, Pusher)
└── Storage Integrations (S3, MinIO)
Built with Node.js 20+, TypeScript 5+, and Express.js, it provides extensive integrations with chatbots, CRM systems, and messaging platforms.
PostgreSQL and MySQL via Prisma ORM with provider-specific schemas and migrations.
- API key-based authentication via
apikeyheader - Instance-specific tokens for WhatsApp connection authentication
- Webhook signature validation for external integrations
RabbitMQ, Amazon SQS, NATS, Pusher and WebSocket for events. Configurable per instance.
Local storage or S3/MinIO. Automatic media download from WhatsApp. Optional audio transcription via OpenAI.
| Resource | Link |
|---|---|
| Website | evolutionfoundation.com.br |
| Swagger UI | /docs |
| Fork documentation | docs/README.md |
| Every Baileys method and response | docs/baileys/README.md |
| WhatsApp usernames and authoritative LIDs | docs/username-lid-identities.md |
| WhatsApp archive | docs/archive.md |
| Local-first reads | docs/local-first-reads.md |
| Every instance setting | docs/settings.md |
| Delete messages for everyone | docs/delete-message.md |
| Community | evolutionfoundation.com.br/community |
| Docker Hub | evoapicloud/evolution-api |
| Changelog | CHANGELOG.md |
| Contributing | CONTRIBUTING.md |
| Security | SECURITY.md |
Deploy Evolution API with optimized infrastructure through our HostGator partnership:
Evolution API collects anonymous telemetry data (routes used, most accessed routes, API version) to help improve the service. No sensitive or personal data is collected. This information helps us identify improvements and provide a better experience for users.
Contributions are welcome! Please read CONTRIBUTING.md for guidelines on how to submit issues, propose features, and open pull requests.
Join our community to discuss ideas and collaborate.
For security issues, do not open a public issue. Email suporte@evofoundation.com.br or use GitHub's private vulnerability reporting. See SECURITY.md for details.
Evolution API is licensed under the Apache License 2.0, with additional brand-protection conditions (LOGO/copyright preservation and Usage Notification requirement). See LICENSE for full details.
For licensing inquiries, contact suporte@evofoundation.com.br.
"Evolution Foundation", "Evolution" and "Evolution API" are trademarks of Evolution Foundation. See TRADEMARKS.md for the brand assets policy.
Third-party attributions are documented in NOTICE.
Made by Evolution Foundation · © 2026