# Deploy Flash API with Easypanel

URL: /templates/flash-api

Flash API is a self-hosted multi-session WhatsApp API platform built on the Baileys library. It lets you connect multiple WhatsApp accounts simultaneously, manage sessions via QR code, and send text, images, video, audio, documents, locations, and polls through a REST API secured by an API key. Features include real-time webhooks and WebSocket support for incoming message events, contact and group management, a built-in web Manager dashboard, and full session persistence in Postgres with Redis-backed caching and queues.

## Installation notes

After deployment, open your domain to log into the Manager panel with username admin and the Manager Password set in this template's form (or the auto-generated one, if left blank). Use the GLOBAL_API_KEY shown in the app environment variables to authenticate API requests directly. Create a session by calling POST /api/session/create_sessao with gerar_qrcode set to true, then scan the returned QR code with WhatsApp on your phone. Database migrations run automatically on every container start, no manual step required.

## Benefits

### Multi-Session WhatsApp

Connect and manage multiple WhatsApp accounts from a single deployment. Each session is isolated, persisted in Postgres, and can be reconnected independently without affecting other sessions.

### Full REST API

Send any type of WhatsApp message — text, images, video, audio, documents, locations, stickers, reactions, and polls — via simple HTTP requests authenticated by an API key.

### Real-Time Events

Receive incoming message and status events instantly via configurable webhooks and a built-in WebSocket server, enabling real-time integrations with chatbots, CRMs, and automation platforms.

## Features

### QR Code Authentication

Authenticate new WhatsApp sessions by generating a Base64 QR code via the API and scanning it with the WhatsApp mobile app — no browser automation required.

### Contact and Group Management

Query contact details, check if numbers are registered on WhatsApp, create and manage groups, update descriptions, and add or remove participants through dedicated API endpoints.

### Manager Dashboard

A built-in web panel at /manager lets you view and operate sessions — generate QR codes, check connection status, and manage sessions — without calling the API directly.

### Webhook Support

Configure per-session or global webhooks to push incoming messages, read receipts, connection status changes, and call events to any HTTP endpoint.

### Session Lifecycle Control

Create, reconnect, restart, and delete sessions via API, with configurable auto-deletion of disconnected sessions and automatic cleanup of temporary messages.

## Configuration

- `appServiceName` (App Service Name, required): flash-api

- `appServiceImage` (App Service Image, required): flashconect/flash-api:v1.0.6

- `managerPassword` (Manager Password): Set during installation — Leave blank to auto-generate a random password.

## Services

- flash-api: app (flashconect/flash-api:v1.0.6)

- flash-api-db: postgres

- flash-api-redis: redis

## Resources

- [GitHub](https://github.com/clsshbr2/FlashApi)

- [Template source](https://github.com/easypanel-io/templates/tree/main/templates/flash-api)