HypioDocumentação

Referência

Erros

O formato do erro e o que fazer com cada código.


Formato

JSON
{
  "error": {
    "code": "insufficient_credits",
    "message": "Saldo insuficiente.",
    "requiredCredits": 120,
    "availableCredits": 40
  }
}

Decida pelo code. A message é para gente e pode mudar.

Códigos

StatuscodeO que fazer
400invalid_jsonCorrija o JSON do corpo.
401unauthorizedConfira a chave e o header Authorization.
402insufficient_creditsRecarregue. O corpo traz requiredCredits e availableCredits.
403insufficient_scopeUse uma chave com o escopo em requiredScope.
403account_suspendedFale com o suporte.
404not_foundO recurso não existe ou é de outra organização.
405method_not_allowedUse um método do header Allow.
409conflictEstado incompatível. Leia de novo e decida.
422validation_errorCorrija o campo em field.
429rate_limitedEspere o Retry-After, em segundos.
429concurrency_limitEspere uma geração terminar. O corpo traz limit.
500internal_errorTente de novo com a mesma Idempotency-Key.

Novas tentativas

Repita só 429 e 5xx, com espera crescente. Num POST, repita sempre com a mesma Idempotency-Key para não gerar e cobrar duas vezes.