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ề.
Hiện tại, việc truy cập API có sẵn cho kế hoạch Studio và cao hơn.
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 bắt buộc trong yêu cầu URL tải lên | Được trả về khi các tham số truy vấn bắt buộc bị thiếu trong yêu cầu URL tải lên. |
| 400 | invalid_request_error | Missing job_id | Được 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 khả dụng cho công việc này | Được trả về khi công việc không có bất kỳ đầu ra nào có thể kết xuất. |
| 400 | invalid_request_error | input_keys must be a non-empty array | Được trả về khi `input_keys` bị thiếu hoặc rỗng. |
| 400 | invalid_request_error | input_keys must contain at least one valid input key | Được trả về khi tất cả các input keys được cung cấp trống hoặc không hợp lệ sau khi chuẩn hóa. |
| 400 | input_duration_requirement_error | Total input duration must be greater than 2 seconds | Được trả về khi tổng thời lượng của tất cả các phương tiện đầu vào là 2 giây hoặc ít hơn. |
| 400 | input_duration_requirement_error | Total input duration must be less than 6 hours | Được trả về khi tổng thời lượng của tất cả các phương tiện đầu vào là 6 giờ hoặc hơn. |
| 400 | input_image_count_requirement_error | Number of input images must be no more than 4000 | Được trả về khi số lượng ảnh đầu vào vượt quá giới hạn tối đa cho phép là 4000. |
| 400 | input_video_count_requirement_error | Number of input videos must be no more than 400 | Được trả về khi số lượng video đầu vào vượt quá giới hạn tối đa cho phép là 400. |
| 400 | invalid_request_error | video_category không hợp lệ. Giá trị cho phép: podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others | Được trả về khi `video_category` không được hỗ trợ. |
| 400 | invalid_request_error | aspect_ratio không hợp lệ. Giá trị cho phép: square, portrait, landscape | Được trả về khi `aspect_ratio` không được hỗ trợ. |
| 400 | invalid_request_error | output_length must be a positive number | Được trả về khi `output_length` bị thiếu, bằng 0, hoặc là số âm. |
| 400 | invalid_request_error | Could not determine positive input duration from input_keys metadata | Được trả về khi API không thể xác định thời lượng hợp lệ cho các đầu vào đã tải lên. |
| 400 | invalid_request_error | music_volume must be a number between 0 and 100 | Được trả về khi `music_volume` được cung cấp nhưng không phải là một số hợp lệ trong khoảng 0 đến 100. |
| 400 | invalid_request_error | original_audio_volume must be a number between 0 and 100 | Được trả về khi `original_audio_volume` được cung cấp nhưng không phải là một số hợp lệ trong khoảng 0 đến 100. |
| 400 | invalid_request_error | music_category không hợp lệ. Giá trị cho phép: corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary, trending_vlogs | Được trả về khi `music_category` được cung cấp nhưng không phù hợp với bất kỳ danh mục nhạc được hỗ trợ nào. |
| 401 | authentication_error | Thiếu khóa API | Được trả về khi header `x-api-key` không được cung cấp. |
| 401 | authentication_error | Khóa API không hợp lệ | Được trả về khi khóa API được cung cấp không khớp với khóa đang hoạt động. |
| 402 | insufficient_balance | Bạn không có đủ tín dụng để xử lý công việc này | Được trả về khi tài khoản không có đủ tín dụng để xử lý hoặc kết xuất. |
| 403 | permission_error | Bạn không có quyền truy cập công việc này | Được trả về khi người dùng đã xác thực không sở hữu công việc được yêu cầu. |
| 403 | permission_error | Bạn không có quyền kết xuất công việc này | Được trả về khi người dùng đã xác thực không sở hữu công việc đang được kết xuất. |
| 404 | invalid_request_error | Không tìm thấy công việc | Được trả về khi công việc đượ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 | Được trả về khi không thể tìm thấy hồ sơ người dùng đã xác thực. |
| 429 | rate_limit_error | Quá nhiều yêu cầu | Được trả về khi client vượt quá tốc độ yêu cầu cho phép đối với endpoint. Giới hạn hiện tại là 60 yêu cầu mỗi phút. Việc giới hạn tần suất chủ yếu áp dụng theo khóa API sử dụng header x-api-key, và sẽ dựa vào địa chỉ IP của client khi không có khóa API. Các client gặp giới hạn này nên giảm tần suất gửi yêu cầu và thử lại sau khi cửa sổ giới hạn tần suất được đặt lại. |
| 429 | rate_limit_error | Bạn đã có 10 công việc đang chạy hoặc đang xếp hàng, đây là số tối đa cho phép. Vui lòng chờ một số công việc hoàn thành trước khi gửi công việc khác. | Được trả về khi người dùng đã có số lượng công việc đang tiến hành tối đa cho phép cả trên các server đang chạy và các công việc đang chờ trong hàng đợi. Giới hạn hiện tại là 10 công việc đang chạy hoặc đang xếp hàng tổng cộng cho mỗi người dùng. Quyền sở hữu được xác định bằng cách so khớp từng job_id trên các server bận và các mục hàng đợi đang chờ trở lại với user_email của công việc đó. Các client gặp giới hạn này nên chờ cho một hoặc nhiều công việc hiện có hoàn thành trước khi tạo hoặc kết xuất công việc khác. |
| 500 | api_error | Lỗi xác thực | Được trả về khi việc xác thực khóa API thất bại một cách bất ngờ trên máy chủ. |
| 500 | api_error | Lỗi máy chủ nội bộ | Được trả về cho các lỗi phía máy chủ không mong đợi ở các endpoint status, render hoặc highlight reel. |
| 500 | server_error | Tạo URL tải lên thất bại | Được trả về khi máy chủ không thể tạo URL tải lên được ký. |