Skip to main content

Formato de erro

Em erros tratados pela plataforma, a resposta costuma ser um JSON:
{
  "error": "CODIGO",
  "message": "Mensagem legível"
}

Códigos frequentes

HTTPerror (exemplos)Quando ocorre
400VALIDATION_ERRORCorpo JSON inválido ou fora do schema (ex.: campo obrigatório ausente, tipo incorreto)
401UNAUTHORIZEDAPI Key inválida ou ausente
402INSUFFICIENT_CREDITSSaldo insuficiente para a consulta
404PRODUCT_NOT_FOUNDProduto inativo, slug inexistente ou sem preço para o plano
502PROVIDER_ERRORFalha ao falar com o fornecedor externo
500INTERNAL_ERRORErro interno não esperado

Limites e desempenho

  • O corpo da consulta aceita document com tamanho limitado (até 100 caracteres no contrato atual).
  • Timeout e rate limiting podem ser aplicados por fornecedor ou pela infraestrutura — consulte o contrato.
  • Use retry com backoff apenas para erros transientes (5xx); evite repetir 400/401/402/404 sem corrigir a causa.

Health check

GET /health retorna status dos serviços internos (database, auxiliary). Útil para monitoramento; não substitui o contrato de SLA comercial.