# RyzeAPI

> Gateway REST que transforma o WhatsApp em uma API moderna: envio e recebimento de mensagens (texto, mídia, sticker, contato, localização, PIX, botões, listas, carrosséis, formulários, enquetes, reações, status), gestão de instâncias multi-número, grupos, comunidades, newsletters, perfil, chat e integração nativa com Chatwoot, com eventos em tempo real via webhook ou WebSocket.

Documentação oficial em três idiomas (PT-BR padrão, EN, ES). A autenticação usa dois tipos de token: **TokenAccount** (header `Authorization: Bearer ...`) para operações de conta/instâncias e **TokenInstance** (header `apikey: ...`) para operações dentro de uma instância já provisionada. Os links abaixo apontam para o markdown bruto da página em PT-BR (sufixo `.md`) — substitua `/pt/` por `/en/` ou `/es/` para as versões em inglês ou espanhol. Para todo o conteúdo em um único arquivo, veja [https://docs.ryzeapi.cloud/llms-full.txt](https://docs.ryzeapi.cloud/llms-full.txt).

## Docs

### Primeiros passos
- [Visão geral](https://docs.ryzeapi.cloud/pt/guide/introduction.md): Integre e automatize o WhatsApp com uma API simples, rápida e em tempo real.
- [Início rápido](https://docs.ryzeapi.cloud/pt/guide/quickstart.md): Crie uma instância, conecte seu WhatsApp e envie sua primeira mensagem em menos de 5 minutos
- [Conceitos](https://docs.ryzeapi.cloud/pt/guide/concepts.md): Glossário e modelo mental para trabalhar com a RyzeAPI

### Fundamentos
- [Autenticação](https://docs.ryzeapi.cloud/pt/guide/authentication.md): Como autenticar suas requisições com TokenAccount e TokenInstance
- [Tipos de erro](https://docs.ryzeapi.cloud/pt/guide/errors.md): Formato das respostas e códigos HTTP que a API retorna
- [Rate limit & CORS](https://docs.ryzeapi.cloud/pt/guide/rate-limit-cors.md): Limites de requisições por minuto e regras de CORS para uso em navegador

### Introdução
- [Visão geral](https://docs.ryzeapi.cloud/pt/api/introduction.md): Referência completa dos endpoints da RyzeAPI, organizados por módulo

### Instância
- [Visão Geral](https://docs.ryzeapi.cloud/pt/api/instance/overview.md): Ciclo de vida das suas conexões com o WhatsApp: criar, conectar, configurar e remover
- [Nova instância](https://docs.ryzeapi.cloud/pt/api/instance/create.md): Provisiona uma nova instância e, opcionalmente, já configura webhook, WebSocket, Chatwoot, proxy, S3 e settings no mesmo request
- [Conectar Instância](https://docs.ryzeapi.cloud/pt/api/instance/connect.md): Inicia a conexão com o WhatsApp e retorna QR code ou pairing code
- [Reconectar Instância](https://docs.ryzeapi.cloud/pt/api/instance/reconnect.md): Reativa o cliente whatsmeow sem invalidar a sessão (não requer re-scan de QR)
- [Listar Instâncias](https://docs.ryzeapi.cloud/pt/api/instance/list.md): Retorna as instâncias visíveis para o token, incluindo status, perfil e resumo de cada integração
- [Definir Configurações](https://docs.ryzeapi.cloud/pt/api/instance/settings-update.md): Atualiza configurações de comportamento da instância
- [Verificar Configurações](https://docs.ryzeapi.cloud/pt/api/instance/settings-read.md): Lê as configurações de comportamento da instância
- [Definir Proxy](https://docs.ryzeapi.cloud/pt/api/instance/proxy-update.md): Define ou remove o proxy individual da instância
- [Verificar Proxy](https://docs.ryzeapi.cloud/pt/api/instance/proxy-read.md): Retorna o proxy configurado para a instância
- [Definir S3](https://docs.ryzeapi.cloud/pt/api/instance/s3-update.md): Define credenciais e bucket S3 para armazenar mídia da instância
- [Verificar S3](https://docs.ryzeapi.cloud/pt/api/instance/s3-read.md): Lê a configuração de armazenamento S3 da instância
- [Verificar Métricas](https://docs.ryzeapi.cloud/pt/api/instance/metrics.md): Retorna contadores agregados de mensagens de uma ou várias instâncias
- [Desconectar Instância](https://docs.ryzeapi.cloud/pt/api/instance/logout.md): Força logout no WhatsApp e desconecta, mas mantém o registro da instância
- [Deletar Instância](https://docs.ryzeapi.cloud/pt/api/instance/delete.md): Remove a instância e todos os seus dados. Operação irreversível

### Eventos
- [Visão Geral](https://docs.ryzeapi.cloud/pt/api/events/overview.md): Receba mensagens, status, chamadas, mudanças de grupo e estado da instância em tempo real via webhook ou WebSocket
- [Catálogo de eventos](https://docs.ryzeapi.cloud/pt/api/events/catalog.md): Schemas, enums e exemplos dos 6 tipos de evento entregues por webhook e WebSocket
- [Definir Webhook](https://docs.ryzeapi.cloud/pt/api/events/webhook-configure.md): Cria ou atualiza um webhook (até 3 habilitados por instância) com filtro de eventos, mídia em base64 e header Authorization próprio
- [Verificar Webhooks](https://docs.ryzeapi.cloud/pt/api/events/webhook-list.md): Lista todos os webhooks configurados na instância ou retorna um único por label
- [Definir Websocket](https://docs.ryzeapi.cloud/pt/api/events/websocket-configure.md): Habilita ou desabilita o WebSocket da instância e define filtro de eventos e mídia em base64
- [Verificar Websocket](https://docs.ryzeapi.cloud/pt/api/events/websocket-read.md): Retorna a configuração atual do WebSocket da instância
- [Conectar via WebSocket](https://docs.ryzeapi.cloud/pt/api/websocket.md): Upgrade /ws/:instance, protocolo, autenticação, validação de Origin, heartbeat e reconexão

### Mensagens
- [Visão Geral](https://docs.ryzeapi.cloud/pt/api/messages/overview.md): Endpoints de envio de mensagens WhatsApp em todos os formatos suportados
- [Enviar Texto](https://docs.ryzeapi.cloud/pt/api/messages/text.md): Envia mensagem de texto com suporte a delay, link preview, reply, reply privado e menções
- [Enviar Mídia](https://docs.ryzeapi.cloud/pt/api/messages/media.md): Envia imagem, vídeo, áudio (voz/regular) ou documento por URL
- [Enviar Sticker](https://docs.ryzeapi.cloud/pt/api/messages/sticker.md): Envia uma figurinha (sticker) a partir de uma URL de imagem (PNG/JPEG/GIF) com conversão automática para WebP 512×512
- [Enviar Contato](https://docs.ryzeapi.cloud/pt/api/messages/contact.md): Envia um ou múltiplos contatos como vCard
- [Enviar Localização](https://docs.ryzeapi.cloud/pt/api/messages/location.md): Envia coordenadas geográficas com nome e endereço
- [Enviar Pix](https://docs.ryzeapi.cloud/pt/api/messages/pix.md): Envia botão de pagamento PIX com chave, comerciante e itens opcionais
- [Enviar Botões](https://docs.ryzeapi.cloud/pt/api/messages/buttons.md): Envia mensagem com até 3 botões interativos (REPLY, URL, CALL ou COPY) e header opcional de mídia
- [Enviar Lista](https://docs.ryzeapi.cloud/pt/api/messages/list.md): Envia menu interativo com seções e opções selecionáveis
- [Enviar Carrossel](https://docs.ryzeapi.cloud/pt/api/messages/carousel.md): Envia mensagem com carrossel de cards (header, corpo, rodapé e botões)
- [Enviar Formulário](https://docs.ryzeapi.cloud/pt/api/messages/form.md): Envia botão que abre Native Flow do WhatsApp para captura estruturada de dados
- [Enviar Enquete](https://docs.ryzeapi.cloud/pt/api/messages/poll.md): Cria enquete (poll) com opções de escolha única ou múltipla
- [Enviar Reação](https://docs.ryzeapi.cloud/pt/api/messages/reaction.md): Reage com emoji a uma mensagem específica (ou remove a reação)
- [Enviar Status](https://docs.ryzeapi.cloud/pt/api/messages/status.md): Publica um status (story de 24h) de texto, imagem, vídeo ou áudio no perfil

### Grupos
- [Visão Geral](https://docs.ryzeapi.cloud/pt/api/groups/overview.md): Criação e gestão de grupos do WhatsApp
- [Criar Grupo](https://docs.ryzeapi.cloud/pt/api/groups/create.md): Cria um novo grupo de WhatsApp com participantes, descrição, foto e permissões iniciais
- [Listar Grupos](https://docs.ryzeapi.cloud/pt/api/groups/list.md): Retorna todos os grupos dos quais a instância faz parte
- [Detalhes do Grupo](https://docs.ryzeapi.cloud/pt/api/groups/info.md): Obtém metadados completos de um grupo a partir de JID, código ou link de convite
- [Atualizar Grupo](https://docs.ryzeapi.cloud/pt/api/groups/update.md): Atualiza nome, descrição, foto e permissões de um grupo existente
- [Gerenciar Participantes](https://docs.ryzeapi.cloud/pt/api/groups/participants.md): Adiciona, remove, promove, rebaixa, aprova ou rejeita participantes em um grupo
- [Entrar em Grupo](https://docs.ryzeapi.cloud/pt/api/groups/join.md): Entra em um grupo via código ou link de convite
- [Resetar Link de Convite](https://docs.ryzeapi.cloud/pt/api/groups/reset-link.md): Revoga o invite link atual e gera um novo código / link para o grupo
- [Solicitações Pendentes](https://docs.ryzeapi.cloud/pt/api/groups/requests.md): Lista solicitações de ingresso pendentes em grupos com aprovação manual
- [Sair do Grupo](https://docs.ryzeapi.cloud/pt/api/groups/leave.md): Remove a instância do grupo informado

### Comunidades
- [Visão Geral](https://docs.ryzeapi.cloud/pt/api/communities/overview.md): Criação e gestão de comunidades (parent groups) via /api/community/*
- [Criar comunidade](https://docs.ryzeapi.cloud/pt/api/communities/create.md): Cria uma comunidade (parent group), opcionalmente vinculando grupos existentes na mesma chamada
- [Listar subgrupos](https://docs.ryzeapi.cloud/pt/api/communities/list-subgroups.md): Retorna grupos vinculados a uma comunidade, incluindo o Grupo de Anúncios
- [Vincular grupos](https://docs.ryzeapi.cloud/pt/api/communities/link.md): Vincula grupos existentes a uma comunidade como subgrupos
- [Desvincular grupos](https://docs.ryzeapi.cloud/pt/api/communities/unlink.md): Remove grupos de uma comunidade. Os grupos continuam existindo como independentes

### Newsletter
- [Visão Geral](https://docs.ryzeapi.cloud/pt/api/newsletter/overview.md): Gestão de canais (channels) do WhatsApp via /api/newsletter/*
- [Criar canal](https://docs.ryzeapi.cloud/pt/api/newsletter/create.md): Cria um novo canal (newsletter) vinculado à conta conectada
- [Listar canais](https://docs.ryzeapi.cloud/pt/api/newsletter/list.md): Lista canais nos quais a conta está inscrita (seguindo ou admin / dono)
- [Info do canal](https://docs.ryzeapi.cloud/pt/api/newsletter/info.md): Obtém detalhes de um canal por JID, link ou código de convite
- [Entrar no canal](https://docs.ryzeapi.cloud/pt/api/newsletter/join.md): Inscreve a conta em um canal existente
- [Sair do canal](https://docs.ryzeapi.cloud/pt/api/newsletter/leave.md): Cancela a inscrição da conta em um canal

### Perfil
- [Visão Geral](https://docs.ryzeapi.cloud/pt/api/profile/overview.md): Gestão do perfil próprio (foto, nome, status), consulta de terceiros e privacidade
- [Atualizar conta](https://docs.ryzeapi.cloud/pt/api/profile/update-account.md): Atualiza foto, nome de exibição e / ou status (about) do perfil da instância
- [Verificar conta](https://docs.ryzeapi.cloud/pt/api/profile/read-account.md): Obtém dados do perfil próprio ou de outro número / LID
- [Atualizar privacidade](https://docs.ryzeapi.cloud/pt/api/profile/update-privacy.md): Atualiza configurações de privacidade (last seen, online, foto, status, leitura, chamadas, grupos)
- [Verificar privacidade](https://docs.ryzeapi.cloud/pt/api/profile/read-privacy.md): Lê as configurações de privacidade atuais da conta

### Chat
- [Visão Geral](https://docs.ryzeapi.cloud/pt/api/chat/overview.md): Gerencie contatos, etiquetas, estado dos chats e atue sobre mensagens já enviadas ou recebidas
- [Histórico do chat](https://docs.ryzeapi.cloud/pt/api/chat/history.md): Solicita as mensagens armazenadas de um chat com filtros opcionais por data
- [Marcar chat como lido](https://docs.ryzeapi.cloud/pt/api/chat/mark-chat-read.md): Marca o chat inteiro como lido ou não-lido
- [Marcar mensagem como lida](https://docs.ryzeapi.cloud/pt/api/chat/mark-read.md): Marca uma mensagem específica como lida (envia ACK de leitura ao remetente)
- [Fixar chat](https://docs.ryzeapi.cloud/pt/api/chat/pin.md): Fixa (pin) ou desfixa um chat no topo da lista
- [Favoritar chat ou mensagem](https://docs.ryzeapi.cloud/pt/api/chat/favorite.md): Marca um chat inteiro ou uma mensagem específica como favorita
- [Silenciar chat](https://docs.ryzeapi.cloud/pt/api/chat/mute.md): Silencia notificações de um chat por um período definido ou indefinido
- [Arquivar chat](https://docs.ryzeapi.cloud/pt/api/chat/archive.md): Arquiva ou desarquiva um chat no WhatsApp
- [Apagar chat inteiro](https://docs.ryzeapi.cloud/pt/api/chat/delete-chat.md): Remove um chat localmente, opcionalmente apagando as mídias
- [Criar etiqueta](https://docs.ryzeapi.cloud/pt/api/chat/tags-create.md): Cria uma nova etiqueta (label) com nome e cor opcional
- [Listar etiquetas](https://docs.ryzeapi.cloud/pt/api/chat/tags-list.md): Lista todas as etiquetas (labels) cadastradas na instância
- [Atribuir etiqueta](https://docs.ryzeapi.cloud/pt/api/chat/tags-assign.md): Aplica uma etiqueta (label) a um chat
- [Contatos por etiqueta](https://docs.ryzeapi.cloud/pt/api/chat/contacts-by-label.md): Filtra chats que possuem uma ou mais etiquetas (labels) atribuídas
- [Desatribuir etiqueta](https://docs.ryzeapi.cloud/pt/api/chat/tags-unassign.md): Remove uma etiqueta (label) específica de um chat
- [Deletar etiqueta](https://docs.ryzeapi.cloud/pt/api/chat/tags-delete.md): Remove uma etiqueta (label) e limpa todas as suas atribuições
- [Listar contatos](https://docs.ryzeapi.cloud/pt/api/chat/contacts-list.md): Lista todos os contatos sincronizados ou consulta um número específico
- [Bloquear/desbloquear contato](https://docs.ryzeapi.cloud/pt/api/chat/block.md): Adiciona ou remove um contato da lista de bloqueados
- [Enviar presença](https://docs.ryzeapi.cloud/pt/api/chat/presence.md): Mostra digitando, gravando ou pausa de áudio para um chat
- [Encaminhar mensagem](https://docs.ryzeapi.cloud/pt/api/chat/forward.md): Reenvia uma mensagem para outro chat com a flag forwarded
- [Editar mensagem](https://docs.ryzeapi.cloud/pt/api/chat/edit.md): Altera o conteúdo de uma mensagem que você enviou
- [Buscar mensagem por ID](https://docs.ryzeapi.cloud/pt/api/chat/find-message.md): Recupera o snapshot de uma mensagem armazenada na ingestão
- [Status de entrega da mensagem](https://docs.ryzeapi.cloud/pt/api/chat/contact-status.md): Consulta o status de entrega de uma mensagem (pending/sent/delivered/read/played)
- [Apagar mensagem](https://docs.ryzeapi.cloud/pt/api/chat/delete-message.md): Revoga uma mensagem para todos ou apaga só do seu lado
- [Mídia em base64](https://docs.ryzeapi.cloud/pt/api/chat/media-base64.md): Recupera o conteúdo de uma mídia armazenada localmente em base64
- [Votos de enquete](https://docs.ryzeapi.cloud/pt/api/chat/poll-read.md): Retorna os votos agregados e o detalhamento por votante de uma enquete

### Chatwoot
- [Visão Geral](https://docs.ryzeapi.cloud/pt/api/chatwoot/overview.md): Integração da RyzeAPI com Chatwoot via RyzeIntegrations bridge, ativação, status e desativação
- [Ativar integração](https://docs.ryzeapi.cloud/pt/api/chatwoot/activate.md): Provisiona a integração Chatwoot via RyzeIntegrations bridge, cria a inbox e abre o WebSocket persistente
- [Status / info](https://docs.ryzeapi.cloud/pt/api/chatwoot/info.md): Lê o estado da integração Chatwoot, enriquecido com dados live do bridge
- [Desativar integração](https://docs.ryzeapi.cloud/pt/api/chatwoot/deactivate.md): Remove a integração Chatwoot, local, no bridge e a inbox no Chatwoot

### Observabilidade
- [Visão Geral](https://docs.ryzeapi.cloud/pt/api/observability/overview.md): Endpoint público de health check para monitorar a disponibilidade da RyzeAPI
- [Health](https://docs.ryzeapi.cloud/pt/api/observability/health.md): Probe combinado, processo, banco de dados e dependências opcionais

## Recursos relacionados

- [Login / Painel RyzeAPI](https://ryzeapi.cloud): provisiona contas, tokens e instâncias para usar a API
- [Changelog](https://ryzeapi.cloud/changelog): histórico de mudanças, novos endpoints e quebras de contrato
- [Postman Collection](https://www.postman.com/orionacademy/ryzeapi/collection/41255336-94ca7952-e66c-4456-9298-a8ca716a5f33?sideView=agentMode): coleção pronta para importar e testar todos os endpoints
- [Community Nodes para n8n](https://npmjs.com/package/n8n-nodes-ryze-api): pacote oficial de nós da RyzeAPI para automações no n8n
- [Comunidade Orion Academy](https://orionacademy.com.br): canal de suporte, tutoriais e discussões sobre a RyzeAPI

## Optional

- [Documentação em inglês](https://docs.ryzeapi.cloud/en/guide/introduction.md): mesmo conteúdo, traduzido para inglês
- [Documentación en español](https://docs.ryzeapi.cloud/es/guide/introduction.md): mismo contenido, traducido al español
- [llms-full.txt](https://docs.ryzeapi.cloud/llms-full.txt): conteúdo completo das páginas em PT-BR inlineado em um único arquivo