Desenvolvedores

Códigos de erro da API do SpeakNotes

Toda falha retorna o mesmo envelope JSON: um código estável, uma mensagem legível, um link para esta página e os campos com erro, quando houver.

O formato

Erros nunca são retornados como HTML. O código é estável e seguro para criar ramificações; a mensagem pode mudar a qualquer momento.

HTTP/1.1 402 Payment Required
X-Request-Id: 0f0a3f2c-6f1e-4a5e-9f1b-9d0b5a2c7e11

{
  "error": {
    "type": "billing_error",
    "code": "insufficient_credits",
    "message": "This operation costs 14 credits and the account has 3 left.",
    "doc_url": "https://speaknotes.io/developers/errors#insufficient_credits",
    "request_id": "0f0a3f2c-6f1e-4a5e-9f1b-9d0b5a2c7e11"
  }
}

Códigos

  • invalid_request400

    The request was malformed or failed validation.

  • invalid_token401

    The credential is missing, malformed, expired, or revoked.

  • insufficient_scope403

    The credential is valid but lacks the scope this operation needs.

  • not_found404

    The requested resource does not exist.

  • method_not_allowed405

    That HTTP method is not supported on this path.

  • conflict409

    The request conflicts with the current state of the resource.

  • payload_too_large413

    The uploaded file exceeds the size limit.

  • unsupported_media_type415

    The file format is not supported.

  • insufficient_credits402

    The account has no credits left for this operation.

  • rate_limited429

    Too many requests. Retry after the interval in the Retry-After header.

  • upstream_failure502

    A provider SpeakNotes depends on failed.

  • content_policy422

    The content was refused by the AI content policy.

  • internal_error500

    SpeakNotes failed to process the request.

O que tentar novamente

Tente novamente erros rate_limited após o intervalo em Retry-After, e erros upstream_failure uma ou duas vezes com backoff. Nunca tente novamente erros invalid_request, insufficient_scope ou content_policy: eles falharão da mesma maneira todas as vezes.

IDs de solicitação

Cada resposta contém um cabeçalho X-Request-Id, e os corpos de erro o repetem. Informe-o ao suporte e a falha exata poderá ser encontrada.