This page is not yet available in English. Read it in Portuguese

Skip to content
Menu da documentação

API

Erros

O formato das respostas de erro e o significado de cada código: autenticação, saldo, política, limites e falhas do provedor.

#Formato

O Gateway responde erros sempre neste formato:

json
{
  "error": {
    "code": "insufficient_credit",
    "message": "...",
    "request_id": "..."
  }
}

As rotas da plataforma (/api/platform/*) usam o mesmo objeto error, com message e, em parte dos casos, code, sem o request_id.

A API v1 (/api/v1/*) usa o envelope { data, error, meta } e códigos próprios: veja API v1 › Erros. Nela, produto não ativo responde 404, não product_not_active.

#Códigos

HTTPCódigoSignificado
400invalid_requestCorpo, campo ou cabeçalho inválido
401unauthenticatedChave ausente, inválida, vencida ou revogada
402insufficient_creditSaldo pré-pago zerado
402invoice_overdueFatura vencida
402billing_account_requiredOrganização sem conta de faturamento
402payment_method_requiredConta por fatura sem forma de pagamento ativa
402subscription_suspendedMensalidade de produto sem pagamento além do prazo
403product_not_activeA organização não tem o Models ativo
403forbiddenChave sem o escopo ou sem workspace
403model_not_allowedModelo não liberado no workspace
403model_restrictedModelo restrito para quem chama
403budget_not_configuredWorkspace sem orçamento definido
413payload_too_largeCorpo acima de 4 MB
422sensitive_data_blockedDado sensível bloqueado na entrada
422sensitive_output_blockedDado sensível bloqueado na saída
429rate_limitedLimite de requisições por minuto
429concurrency_limitedLimite de chamadas simultâneas
429budget_exceededOrçamento do workspace ou de uma regra esgotado
429org_budget_exceededTeto mensal da organização atingido
429billing_limit_reachedLimite mensal de cobrança atingido
502, 503, 504—Falha ou demora do provedor do modelo

#O que fazer em cada caso

Vale tentar de novo

  • rate_limited e concurrency_limited: espere e repita, com intervalo crescente.
  • 502, 503 e 504: falha do provedor. Repita com intervalo, ou use uma rota com reserva.

Não adianta repetir

  • insufficient_credit: faça uma recarga em Cobrança.
  • budget_exceeded, org_budget_exceeded: o orçamento precisa ser revisto por quem administra.
  • model_not_allowed: libere o modelo no workspace ou use outro.
  • sensitive_data_blocked: retire o dado do texto, ou peça a quem administra para rever a política.

Nota

Um erro de autenticação do provedor chega a você como 502, não como 401: a sua chave da AIUBY continua válida, e o problema está na conexão da plataforma com o provedor.