API pública
Crie uma chave de API, autentique com X-API-Key e consulte a referência interativa dos endpoints.
A API pública do Anyia permite que sistemas externos criem clientes e enfileirem notificações de WhatsApp. Esta página é voltada a quem vai integrar.
Referência dos endpoints
A lista completa de endpoints, com parâmetros, exemplos e resposta de cada um, fica na
referência interativa publicada pela própria API — em /docs do host da API pública.
Ela é gerada a partir do código, então está sempre atualizada.
O link exato aparece na tela de API Keys da sua organização, já apontando para o ambiente certo.
Criar uma chave
As chaves ficam em Organização → Configurações → API Keys e exigem permissão de administrador.
- Clique em criar uma nova chave.
- Dê um Nome que lembre o uso, ex.:
integração CRM. - Escolha a Expiração — um dos períodos sugeridos, uma data específica ou sem expiração.
- Copie a chave imediatamente. Ela é exibida uma única vez.
Chaves expiradas aparecem sinalizadas na lista. Você pode revogar uma chave a qualquer
momento — as chamadas que a usam passam a receber 401 na hora.
Autenticar as chamadas
Envie a chave no cabeçalho X-API-Key. Ela tem o formato anyia_pk_<prefixo>.<segredo>.
curl https://api.anyia.ia.br/instances/minha-instancia/customers \
-H "X-API-Key: anyia_pk_abc123.SEGREDO"Chave ausente, malformada, revogada ou expirada retorna:
{ "message": "Invalid X-API-Key" }Uma instância que não pertence à organização da chave retorna 404 — nunca 403 — para
não revelar a existência de instâncias de terceiros.
Limites de uso
O limite é de 60 requisições por minuto por chave de API (ou por IP, se não houver chave). Ao estourar:
{ "statusCode": 429, "message": "Too many requests, retry in 60 seconds" }Verificação rápida
O endpoint GET /health não exige autenticação e serve para checar se a API está no ar.
O que fazer com os envios
Tudo que entra pela API aparece no relatório de notificações da instância, com status, erro e data de resposta.