Overview Instances Create QR Send Message Re-Init Chats Agent URL Health

Architecture Overview

Single public Gateway routes all traffic to internal Shard workers. Only ONE shard owns an instance. 

ROLE=gateway → Public API + UI
ROLE=shard   → WhatsApp Engine
  • Shard-safe (no logout loops)
  • Queued & throttled messaging
  • Horizontal scaling ready

List Instances

GET 
GET /api/instances














Create Instance

POST




















Get QR Code

GET




















Send Message (Queued)

POST





⚠ Uses LABEL, not ID. Message is queued.
























Force Re-Initialization

POST




















List Chats

GET


















Agent URL (Auto-Create)


GET /agent/{label}


Creates instance if missing and opens agent UI.














Gateway Health

GET