> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Integrate and automate WhatsApp with a simple, fast, real-time API.

## What is RyzeAPI

**RyzeAPI** is a REST gateway that turns WhatsApp into a modern API, letting systems, CRMs, bots, automations, and dashboards **send and receive messages, manage groups, publish to channels, and react to events in real time**, without having to deal with the complexity of WhatsApp Web's internal protocol.

You send an HTTP request, RyzeAPI handles the rest.

<CardGroup cols={2}>
  <Card title="Messages in any format" icon="message">
    Text, media, stickers, location, contacts, reactions, polls, carousels, lists, buttons, forms, and even PIX.
  </Card>

  <Card title="Multiple instances per account" icon="layer-group">
    Manage multiple WhatsApp numbers simultaneously, each with its own token and isolated settings.
  </Card>

  <Card title="Real-time events" icon="bolt">
    Receive messages, delivery status, and group changes via webhook or WebSocket. Up to 3 simultaneous webhooks per instance.
  </Card>

  <Card title="Advanced native features" icon="wand-magic-sparkles">
    Carousels, interactive buttons, lists, forms, and PIX buttons, features that are normally unavailable in generic WhatsApp APIs.
  </Card>
</CardGroup>

## What you can do

RyzeAPI covers the full WhatsApp integration lifecycle:

* **1-to-1 and group conversations**, send and receive any kind of content
* **Contact management**, list, organize with labels, block, favorite
* **Groups**, create, invite, moderate, update name/description/photo, manage participants
* **Communities**, create communities and link your groups
* **Newsletters (channels)**, broadcast to followers
* **Account profile**, name, photo, privacy
* **Stories (status)**, publish status posts that disappear in 24h
* **Live events**, webhooks and WebSockets to react in real time

## Architecture of your integration

Understanding these 3 levels helps you design your application correctly:

<Steps>
  <Step title="Your account (Account)">
    Your space on RyzeAPI. Has a unique **TokenAccount** and a limit on how many instances you can create.
  </Step>

  <Step title="Your instances (Instance)">
    Each instance is **an active connection to a WhatsApp number**. One account can have several, for example one for sales, another for support, another for marketing.

    Each instance receives its own **TokenInstance** when created.
  </Step>

  <Step title="Your day-to-day operations">
    Use the TokenInstance. Sending messages, reading contacts, creating groups, configuring webhooks, everything goes through the specific instance's token.
  </Step>
</Steps>

## Getting started

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/en/guide/quickstart">
    Connect your WhatsApp and send your first message in less than 5 minutes.
  </Card>

  <Card title="Concepts" icon="book" href="/en/guide/concepts">
    Understand the core concepts before diving into the endpoints.
  </Card>

  <Card title="Authentication" icon="key" href="/en/guide/authentication">
    How to use TokenAccount and TokenInstance.
  </Card>

  <Card title="Error types" icon="triangle-exclamation" href="/en/guide/errors">
    Response formats and how to handle each HTTP code.
  </Card>
</CardGroup>

## Explore the modules

The API is organized into **modules**. Each one groups endpoints that handle a specific aspect of WhatsApp.

<CardGroup cols={3}>
  <Card title="Instance" icon="server" href="/en/api/instance/overview">
    Create, connect, disconnect, adjust settings.
  </Card>

  <Card title="Messages" icon="message" href="/en/api/messages/overview">
    Send all types: text, media, buttons, carousels, lists.
  </Card>

  <Card title="Chat" icon="comments" href="/en/api/chat/overview">
    Contacts, labels, archive, pin, edit, delete messages.
  </Card>

  <Card title="Groups" icon="users" href="/en/api/groups/overview">
    Create groups, manage participants, invite links.
  </Card>

  <Card title="Communities" icon="building" href="/en/api/communities/overview">
    Create communities and link your groups.
  </Card>

  <Card title="Newsletter" icon="newspaper" href="/en/api/newsletter/overview">
    Create and manage broadcast channels.
  </Card>

  <Card title="Profile" icon="user" href="/en/api/profile/overview">
    Name, photo, and privacy of the WhatsApp account.
  </Card>

  <Card title="Events" icon="webhook" href="/en/api/events/overview">
    Configure webhooks and WebSockets per instance.
  </Card>

  <Card title="WebSocket" icon="plug" href="/en/api/websocket">
    Persistent connection for real-time events.
  </Card>

  <Card title="Chatwoot" icon="puzzle-piece" href="/en/api/chatwoot/overview">
    Native integration with Chatwoot.
  </Card>
</CardGroup>