Lỗi
API VIDIO sử dụng định dạng đối tượng lỗi nhất quán. Sử dụng trang này để hiểu các loại lỗi phổ biến, mã trạng thái HTTP và các thông điệp ví dụ do API trả về.
Truy cập API hiện chỉ có sẵn cho các gói Doanh nghiệp. Yêu cầu truy cập tại đây nếu bạn không phải là người dùng Doanh nghiệp nhưng quan tâm đến việc sử dụng API.
Tổng quan
Khi một yêu cầu không thành công, API VIDIO trả về một đối tượng error với một type và message. Một số lỗi cũng có thể bao gồm các trường bổ sung để giúp giải thích sự cố.
Định dạng lỗi
json
{
"error": {
"type": "invalid_request_error",
"message": "Không tìm thấy công việc"
}
}Tài liệu tham khảo lỗi
| Status | Type | Message | Description |
|---|---|---|---|
| 400 | invalid_request_error | Thiếu tham số truy vấn yêu cầu trong yêu cầu URL tải lên | Trả về khi các tham số truy vấn cần thiết bị thiếu trong yêu cầu URL tải lên. |
| 400 | invalid_request_error | Thiếu job_id | Trả về khi yêu cầu render không bao gồm ID công việc. |
| 400 | invalid_request_error | Không có đầu ra nào cho công việc này | Trả về khi công việc không có đầu ra nào có thể render. |
| 400 | invalid_request_error | input_keys phải là một mảng không có giá trị trống | Trả về khi `input_keys` bị thiếu hoặc trống. |
| 400 | invalid_request_error | input_keys phải chứa ít nhất một khóa đầu vào hợp lệ | Trả về khi tất cả các khóa đầu vào đã cung cấp đều trống hoặc không hợp lệ sau khi chuẩn hóa. |
| 400 | invalid_request_error | video_category không hợp lệ. Các giá trị cho phép: podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others | Trả về khi `video_category` không được hỗ trợ. |
| 400 | invalid_request_error | aspect_ratio không hợp lệ. Các giá trị cho phép: square, portrait, landscape | Trả về khi `aspect_ratio` không được hỗ trợ. |
| 400 | invalid_request_error | output_length phải là một số dương | Trả về khi `output_length` bị thiếu, bằng không hoặc âm. |
| 400 | invalid_request_error | Không thể xác định thời gian đầu vào dương từ siêu dữ liệu input_keys | Trả về khi API không thể xác định thời gian hợp lệ cho các đầu vào đã tải lên. |
| 401 | authentication_error | Thiếu khóa API | Trả về khi tiêu đề `x-api-key` không được cung cấp. |
| 401 | authentication_error | Khóa API không hợp lệ | Trả về khi khóa API được cung cấp không khớp với một khóa hoạt động. |
| 402 | insufficient_balance | Bạn không đủ tín dụng để xử lý công việc này | Trả về khi tài khoản không có đủ tín dụng để xử lý hoặc render. |
| 403 | permission_error | Bạn không có quyền truy cập vào công việc này | Trả về khi người dùng xác thực không sở hữu công việc đã yêu cầu. |
| 403 | permission_error | Bạn không có quyền render công việc này | Trả về khi người dùng xác thực không sở hữu công việc đang được render. |
| 404 | invalid_request_error | Không tìm thấy công việc | Trả về khi công việc đã yêu cầu không tồn tại. |
| 404 | invalid_request_error | Không tìm thấy người dùng | Trả về khi bản ghi người dùng đã xác thực không thể được tìm thấy. |
| 429 | rate_limit_error | Quá nhiều yêu cầu | Trả về khi khách hàng vượt quá tỷ lệ yêu cầu cho phép cho điểm cuối. Giới hạn hiện tại là 60 yêu cầu mỗi phút. Giới hạn tỷ lệ chủ yếu áp dụng theo khóa API bằng cách sử dụng tiêu đề x-api-key, và quay lại địa chỉ IP của khách hàng khi không có khóa API. Các khách hàng gặp giới hạn này nên giảm tần suất yêu cầu và thử lại sau khi cửa sổ giới hạn tỷ lệ được đặt lại. |
| 500 | api_error | Lỗi xác thực | Trả về khi lỗi xác thực khóa API xảy ra bất ngờ trên máy chủ. |
| 500 | api_error | Lỗi máy chủ nội bộ | Trả về cho các lỗi bất ngờ ở phía máy chủ trong các điểm cuối trạng thái, render hoặc highlight reel. |
| 500 | server_error | Không thể tạo URL tải lên | Trả về khi máy chủ không thể tạo một URL tải lên đã ký. |