GET/api/v1/health

Health check

Público

Endpoint utilitário para verificar a disponibilidade do serviço. É uma rota pública — não requer Bearer token. Útil para health checks de monitoramento e verificações de uptime.

Exemplo de request

cURL
curl https://avatrix.io/api/v1/health

Resposta — 200

Responde 200 OK quando o serviço está operacional, dentro do envelope padrão:

JSON
{
  "success": true,
  "data": {
    "status": "ok",
    "message": "This API is working."
  }
}

O data carrega um indicador simples de status do serviço. Trate qualquer resposta 2xx como "API no ar"; um código diferente (ou ausência de resposta) indica indisponibilidade.

Notas

  • Não requer autenticação nem escopo.
  • Não consome créditos e não está sujeito ao rate limit por token dos demais endpoints.