WhatsApp SaaS Documentation

Platform Overview & Getting Started

← Back to Home

Introduction

Welcome to the WhatsApp API SaaS documentation. Our platform provides a robust, RESTful API to programmatically interact with WhatsApp. Built on top of the powerful Baileys library, we offer a multi-session architecture that allows you to manage hundreds of WhatsApp numbers from a single dashboard.

Key Capabilities

  • Send Text, Images, Videos, Audio, and Documents.
  • Create and manage Groups.
  • Real-time event notifications via Webhooks.
  • Interactive Polls and Location sharing.

Quick Start

  1. Create an Account: Register on the platform to get your main API Access.
  2. Start a Session: Go to the Dashboard and click Add Device. Give it a name (e.g., "Support-Bot").
  3. Scan QR Code: Click "Connect" and scan the QR code with your WhatsApp mobile app (Linked Devices).
  4. Get API Key: Once connected, the dashboard will reveal your unique x-api-key for that session.

Authentication

All API requests require authentication. We use header-based authentication.

x-api-key: your_session_api_key

For Dashboard-related actions (creating sessions, etc.), we use standard JWT Bearer tokens which are handled automatically by the frontend.

Sessions

A Session represents a single connected WhatsApp phone number. Each session runs in isolation, meaning actions on one session do not affect others. You can indefinitely scale the number of sessions based on your server capacity.

Full API Reference

For detailed endpoint documentation, request examples, and response schemas, please visit our interactive API Playground and Reference inside the Dashboard.

Go to API Reference →