> ## 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.

# Visão geral

> Integre e automatize o WhatsApp com uma API simples, rápida e em tempo real.

## O que é a RyzeAPI

A **RyzeAPI** é um gateway REST que transforma o WhatsApp em uma API moderna, permitindo que sistemas, CRMs, bots, automações e dashboards **enviem e recebam mensagens, gerenciem grupos, publiquem em canais e reajam a eventos em tempo real**, sem lidar com a complexidade do protocolo interno do WhatsApp Web.

Você envia uma requisição HTTP, a RyzeAPI cuida do resto.

<CardGroup cols={2}>
  <Card title="Mensagens em qualquer formato" icon="message">
    Texto, mídia, stickers, localização, contatos, reações, enquetes, carrosséis, listas, botões, formulários e até PIX.
  </Card>

  <Card title="Múltiplas instâncias por conta" icon="layer-group">
    Gerencie vários números de WhatsApp simultaneamente, cada um com token próprio e configurações isoladas.
  </Card>

  <Card title="Eventos em tempo real" icon="bolt">
    Receba mensagens, status de entrega e mudanças de grupo via webhook ou WebSocket. Até 3 webhooks simultâneos por instância.
  </Card>

  <Card title="Recursos nativos avançados" icon="wand-magic-sparkles">
    Carrosséis, botões interativos, listas, formulários e botões PIX, recursos normalmente indisponíveis em APIs genéricas do WhatsApp.
  </Card>
</CardGroup>

## O que você pode fazer

A RyzeAPI cobre o ciclo completo de integração com o WhatsApp:

* **Conversas 1-a-1 e em grupo**, envie e receba qualquer tipo de conteúdo
* **Gestão de contatos**, liste, organize em etiquetas, bloqueie, favorite
* **Grupos**, crie, convide, modere, atualize nome/descrição/foto, gerencie participantes
* **Comunidades**, crie comunidades e vincule seus grupos
* **Canais (newsletters)**, publique em broadcast para seguidores
* **Perfil da conta**, nome, foto, privacidade
* **Stories (status)**, publique status que somem em 24h
* **Eventos ao vivo**, webhooks e WebSockets para reagir em tempo real

## Arquitetura da sua integração

Entender estes 3 níveis ajuda a desenhar sua aplicação corretamente:

<Steps>
  <Step title="Sua conta (Account)">
    Seu espaço na RyzeAPI. Tem um **TokenAccount** único e um limite de quantas instâncias você pode criar.
  </Step>

  <Step title="Suas instâncias (Instance)">
    Cada instância é **uma conexão ativa com um número de WhatsApp**. Uma conta pode ter várias, por exemplo, uma para vendas, outra para suporte, outra para marketing.

    Cada instância recebe um **TokenInstance** próprio ao ser criada.
  </Step>

  <Step title="Suas operações do dia a dia">
    Usam o TokenInstance. Enviar mensagens, ler contatos, criar grupos, configurar webhooks, tudo passa pelo token da instância específica.
  </Step>
</Steps>

## Primeiros passos

<CardGroup cols={2}>
  <Card title="Início rápido" icon="rocket" href="/pt/guide/quickstart">
    Conecte seu WhatsApp e envie sua primeira mensagem em menos de 5 minutos.
  </Card>

  <Card title="Conceitos" icon="book" href="/pt/guide/concepts">
    Entenda os conceitos centrais antes de mergulhar nos endpoints.
  </Card>

  <Card title="Autenticação" icon="key" href="/pt/guide/authentication">
    Como usar TokenAccount e TokenInstance.
  </Card>

  <Card title="Tipos de erro" icon="triangle-exclamation" href="/pt/guide/errors">
    Formatos de resposta e como tratar cada código HTTP.
  </Card>
</CardGroup>

## Explore os módulos

A API é organizada em **módulos**. Cada um agrupa endpoints que cuidam de um aspecto específico do WhatsApp.

<CardGroup cols={3}>
  <Card title="Instância" icon="server" href="/pt/api/instance/overview">
    Criar, conectar, desconectar, ajustar configurações.
  </Card>

  <Card title="Mensagens" icon="message" href="/pt/api/messages/overview">
    Enviar todos os tipos: texto, mídia, botões, carrosséis, listas.
  </Card>

  <Card title="Chat" icon="comments" href="/pt/api/chat/overview">
    Contatos, etiquetas, arquivar, fixar, editar, apagar mensagens.
  </Card>

  <Card title="Grupos" icon="users" href="/pt/api/groups/overview">
    Criar grupos, gerenciar participantes, links de convite.
  </Card>

  <Card title="Comunidades" icon="building" href="/pt/api/communities/overview">
    Criar comunidades e vincular seus grupos.
  </Card>

  <Card title="Newsletter" icon="newspaper" href="/pt/api/newsletter/overview">
    Criar e gerenciar canais de broadcast.
  </Card>

  <Card title="Perfil" icon="user" href="/pt/api/profile/overview">
    Nome, foto e privacidade da conta WhatsApp.
  </Card>

  <Card title="Eventos" icon="webhook" href="/pt/api/events/overview">
    Configurar webhooks e WebSockets por instância.
  </Card>

  <Card title="WebSocket" icon="plug" href="/pt/api/websocket">
    Conexão persistente para eventos em tempo real.
  </Card>

  <Card title="Chatwoot" icon="puzzle-piece" href="/pt/api/chatwoot/overview">
    Integração nativa com o Chatwoot.
  </Card>
</CardGroup>