> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/whiskeysockets/Baileys/llms.txt
> Use this file to discover all available pages before exploring further.

# Baileys - WhatsApp Web API

> A lightweight, WebSocket-based TypeScript library for interacting with the WhatsApp Web API without browser dependencies

<img className="block" src="https://raw.githubusercontent.com/WhiskeySockets/Baileys/refs/heads/master/Media/logo.png" alt="Baileys Logo" height="150" />

## What is Baileys?

Bailey is a **WebSocket-based TypeScript library** for interacting with the WhatsApp Web API. It provides a complete, efficient solution for building WhatsApp automation without the overhead of browser automation tools.

<Note>
  Baileys connects directly to WhatsApp Web using **WebSockets** - no Selenium, Chromium, or browser required. This saves approximately **half a gigabyte of RAM** compared to browser-based solutions.
</Note>

## Key Features

<CardGroup cols={2}>
  <Card title="Browser-Free" icon="rocket">
    Direct WebSocket connection to WhatsApp Web - no Selenium or Chromium required
  </Card>

  <Card title="Multi-Device Support" icon="mobile">
    Full support for WhatsApp's multi-device and web versions
  </Card>

  <Card title="Memory Efficient" icon="gauge-high">
    Saves \~500MB of RAM by eliminating browser overhead
  </Card>

  <Card title="TypeScript First" icon="code">
    Written in TypeScript with complete type definitions
  </Card>

  <Card title="Rich Messaging" icon="message">
    Send text, media, polls, reactions, locations, contacts, and more
  </Card>

  <Card title="Event-Driven" icon="bolt">
    EventEmitter-based architecture for handling messages and events
  </Card>

  <Card title="Session Management" icon="key">
    Built-in authentication state management with multi-file support
  </Card>

  <Card title="Group Management" icon="users">
    Complete API for creating and managing WhatsApp groups
  </Card>
</CardGroup>

## Authentication Methods

Baileys supports two authentication methods:

<CardGroup cols={2}>
  <Card title="QR Code" icon="qrcode" href="/guides/connecting-qr-code">
    Scan a QR code with your phone to authenticate
  </Card>

  <Card title="Pairing Code" icon="mobile-screen" href="/guides/connecting-pairing-code">
    Use a pairing code for authentication without QR scanning
  </Card>
</CardGroup>

## What You Can Build

* **Customer Support Bots** - Automated responses and ticket management
* **Notification Systems** - Send alerts and updates to users
* **Group Management Tools** - Automate group administration
* **Analytics Platforms** - Track message metrics and engagement
* **Integration Bridges** - Connect WhatsApp with other services
* **Broadcasting Tools** - Send bulk messages to multiple recipients

<Warning>
  **Important:** This project is not affiliated with WhatsApp. Use responsibly and in accordance with WhatsApp's Terms of Service. Do not use for spam or unauthorized bulk messaging.
</Warning>

## Quick Links

<CardGroup cols={3}>
  <Card title="Installation" icon="download" href="/installation">
    Install Baileys and get started
  </Card>

  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Send your first message in minutes
  </Card>

  <Card title="API Reference" icon="book" href="/api/makewasocket">
    Explore the complete API
  </Card>
</CardGroup>

## Package Information

* **Package Name:** `@whiskeysockets/baileys`
* **Current Version:** 7.0.0 (release candidate)
* **License:** MIT
* **Minimum Node.js:** 20.0.0+
* **GitHub:** [WhiskeySockets/Baileys](https://github.com/whiskeysockets/Baileys)

## Community & Support

<CardGroup cols={2}>
  <Card title="Discord Community" icon="discord" href="https://discord.gg/WeJM5FP9GG">
    Join our Discord server for help and discussions
  </Card>

  <Card title="GitHub Issues" icon="github" href="https://github.com/whiskeysockets/Baileys/issues">
    Report bugs and request features
  </Card>
</CardGroup>

## Disclaimer

This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates. The official WhatsApp website can be found at [whatsapp.com](https://whatsapp.com).

The maintainers of Baileys do not condone the use of this library in practices that violate WhatsApp's Terms of Service. Users are responsible for using this library fairly and as intended. **Do not spam people with this library.**