Nhà phát triển

Mã lỗi API SpeakNotes

Mọi lỗi đều trả về cùng một phong bì JSON: mã ổn định, thông báo dễ đọc, liên kết đến trang này và các trường bị lỗi nếu có.

Hình dạng

Lỗi không bao giờ trả về dưới dạng HTML. Mã lỗi ổn định và an toàn để phân nhánh; thông báo có thể thay đổi bất cứ lúc nào.

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"
  }
}

Mã lỗi

  • 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.

Khi nào cần thử lại

Hãy thử lại lỗi rate_limited sau khoảng thời gian trong Retry-After, và thử lại upstream_failure một hoặc hai lần với cơ chế backoff. Không bao giờ thử lại các lỗi invalid_request, insufficient_scope, hoặc content_policy vì chúng sẽ luôn thất bại theo cùng một cách.

ID yêu cầu

Mỗi phản hồi đều chứa tiêu đề X-Request-Id, và nội dung lỗi sẽ lặp lại tiêu đề này. Hãy cung cấp nó cho bộ phận hỗ trợ để xác định chính xác lỗi xảy ra.