Lỗi

Reigniter API sử dụng mã trạng thái HTTP chuẩn. Mỗi phản hồi lỗi đều JSON.

Nội dung lỗi

Hầu hết các lỗi đều như sau:

{
  "error": "Rate limit exceeded",
  "code": "RATE_LIMITED",
  "retryAfter": 37
}

Lĩnh vực	Luôn hiện diện	Nó là gì
error	Đúng vậy	Một tin nhắn bạn có thể hiển thị cho một người. Nó có thể thay đổi cách diễn đạt, nên đừng khớp với nó.
code	Nhiều lỗi nhất	Một mã ổn định, chữ hoa. Nhánh trên cái này.
details	Một số lỗi	Thêm bối cảnh, ví dụ như retryAfter hoặc số liệu sử dụng.
retryAfter	Một số 429s	Chờ vài giây trước khi thử lại.

Một vài lỗi không có code, như 404 Job not found và 403 Forbidden. Hãy phân nhánh trạng thái cho những lỗi đó.

Lỗi xác thực

Khi phần thân yêu cầu không khớp với sơ đồ, bạn sẽ nhận được 400 với chuỗi detail liệt kê mọi vấn đề dưới dạng field: message:

{
  "error": "Validation failed",
  "detail": "aspect: Invalid option: expected one of \"9:16\"|\"16:9\"|\"1:1\"|\"4:5\"|\"4:3\"|\"3:4\""
}

Mã trạng thái

Tình trạng	Ý nghĩa	Phải làm gì
200	Thành công.
201	Đã tạo (webhooks).
202	Được chấp nhận. Quá trình render đã bắt đầu.	Khảo sát công việc hoặc chờ webhook.
400	Yêu cầu đã bị từ chối. Không có gì bị tính phí.	Sửa yêu cầu. Không thử lại mà không thay đổi.
401	Khóa API bị mất, không hợp lệ hoặc bị thu hồi.	Kiểm tra chìa khóa.
402	Vấn đề về kế hoạch, tín dụng hoặc sử dụng.	Đọc code.
403	Tài khoản bị tạm ngưng, hoặc một công việc không thuộc về bạn.	Liên hệ bộ phận hỗ trợ, hoặc kiểm tra mã công việc.
404	Không tìm thấy.	Kiểm tra ID hoặc đường dẫn.
409	Đã đạt yêu cầu hoặc giới hạn trùng lặp.	Đọc code.
413	Việc render này sẽ tốn nhiều hơn giới hạn mỗi lần render.	Dùng ít cảnh hơn hoặc quality thấp hơn.
422	Kết xuất không có thương hiệu, sản phẩm hay người trình bày để làm điểm tựa.	Xem phần Tạo video.
429	Quá nhiều yêu cầu hoặc quá nhiều bản render cùng lúc.	Chờ và thử lại. Xem Giới hạn.
500	Có chuyện gì đó không ổn bên chúng ta.	Thử lại sau.
502	Lập kế hoạch từ bản tóm tắt của bạn đã thất bại. Các khoản tín dụng lập kế hoạch đã được hoàn trả.	Thử lại, hoặc diễn đạt lại bản tóm tắt.
503	Việc render bị tạm dừng hoặc dịch vụ bị ngắt. Không có gì bị tính phí.	Thử lại sau.

Một đường đi không xác định dưới /v1/ trả về 404 với code: "NOT_FOUND".

Mã lỗi

Xác thực và kế hoạch

Mã nguồn	Tình trạng	Ý nghĩa
NO_API_KEY	401	Không có tiêu đề Authorization, hoặc token không bắt đầu bằng emp_.
INVALID_API_KEY	401	Chìa khóa không được biết hoặc đã bị thu hồi.
PLAN_UPGRADE_REQUIRED	402	Truy cập API cần kế hoạch Agency.
ACCOUNT_SUSPENDED	403	Tài khoản bị tạm ngưng.

Tín dụng và cách sử dụng

Mã nguồn	Tình trạng	Ý nghĩa
NO_CREDITS	402	Tài khoản không còn tín dụng nào.
INSUFFICIENT_CREDITS	402	Không đủ tín dụng cho bản render này.
ABUSE_CAP_EXCEEDED	402	Giới hạn sử dụng hàng tháng của gói đã được đạt đến.
STORAGE_FULL	402	Thư viện video của tài khoản đã đầy. Xóa một số video.
UPGRADE_REQUIRED	402	Video cần gói trả phí.
REQUEST_COST_TOO_HIGH	413	Một lần render này sẽ tốn nhiều hơn giới hạn mỗi lần render.

Xem Tài khoản và thanh toán để biết các khoản tín dụng và kế hoạch.

Yêu cầu render

Mã nguồn	Tình trạng	Ý nghĩa
CONTENT_BLOCKED	400	Bản tóm tắt hoặc một cảnh vi phạm quy tắc nội dung.
PRODUCT_IMAGE_REQUIRED	400	Định dạng này cần product_image_url, hoặc product_enabled: false.
PRESENTER_REQUIRED	400	Một cảnh nói chuyện không có mặt. Thêm avatar_preset_id, hoặc gửi presenter_enabled: false.
UNSUPPORTED_MODEL	400	Một cảnh yêu cầu mô hình kết xuất Reigniter không thể sử dụng.
BRAND_REQUIRED	422	Một thương hiệu đã được hỏi nhưng không tìm thấy. Gửi brand_logo_url.
NO_ANCHOR	422	Không có thương hiệu, ảnh sản phẩm hay người thuyết trình. Thêm một người hoặc từ chối.
CANVAS_NOT_FOUND	404	Dự án được tham chiếu không nằm trong tài khoản này.
DUPLICATE_REQUEST	409	Idempotency-Key này đã được sử dụng rồi. Không có gì mới được tính phí.
PLAN_FAILED	502	Việc lập kế hoạch từ bản tóm tắt đã thất bại. Các khoản tín dụng lập kế hoạch được hoàn trả.

Với brief, một Idempotency-Key lặp lại cũng có thể trở về như 402 với thông điệp This request was already submitted. Hãy xem nó như một bản sao trùng lặp, không phải là vấn đề tín dụng.

Tốc độ và đồng thời

Mã nguồn	Tình trạng	Ý nghĩa
RATE_LIMITED	429	Quá nhiều yêu cầu. Chờ retryAfter (hoặc details.retryAfter) giây.
CONCURRENT_LIMIT	429	Quá nhiều bản render chạy cùng lúc. Chờ một bản hoàn thành.

Phục vụ

Mã nguồn	Tình trạng	Ý nghĩa
USAGE_CHECK_UNAVAILABLE	503	Không thể kiểm tra việc sử dụng, nên việc hiển thị bị tạm dừng. Không có gì bị tính phí.
DB_UNAVAILABLE	503	Dịch vụ này tạm thời không khả dụng.
FEATURE_NOT_AVAILABLE	503	Hiện chưa có chế độ render.
GLOBAL_KILL_SWITCH	503	Việc kết xuất sẽ tạm dừng cho tất cả mọi người.
FEATURE_KILL_SWITCH	503	Tính năng này đang tạm dừng.
USER_KILL_SWITCH	503	Tài khoản này tạm thời bị hạn chế. Liên hệ bộ phận hỗ trợ.

Webhooks

Mã nguồn	Tình trạng	Ý nghĩa
UNKNOWN_EVENT	400	Không phải sự kiện bạn có thể đăng ký. Phản hồi liệt kê những sự kiện hợp lệ.
URL_NOT_DELIVERABLE	400	URL không phải là địa chỉ http(s) công khai.
HOOK_LIMIT	409	Tài khoản đã có số lượng webhook tối đa.

Thử lại an toàn

• Thử lại 429, 500, 502 và 503 với backoff. Không thử lại các 4xx khác mà không thay đổi.
• Luôn gửi Idempotency-Key trên POST /v1/render.
• Không có phản hồi nào (hết thời gian chờ hoặc mất kết nối): thử lại với cùng một khóa. Nếu yêu cầu đầu tiên đã bắt đầu render, lần thử lại sẽ bị từ chối thay vì bắt đầu lần thứ hai.
• Phản hồi lỗi: không có render nào được khởi động cho yêu cầu đó. Sửa nguyên nhân, sau đó thử lại với khóa mới, vì một yêu cầu thất bại một phần có thể đã dùng khóa của nó. Tín dụng render được hoàn lại. Khoản phí duy nhất không được hoàn lại là lập kế hoạch ngắn, khi render dự kiến bị từ chối (xem Làm video).
• Nếu một bản render được chấp nhận (202) và sau đó thất bại, status của công việc sẽ trở thành failed và error sẽ nói lý do. Các khoản tín dụng cho công việc không thực hiện sẽ được hoàn trả.