ข้อผิดพลาด
VIDIO API ใช้รูปแบบวัตถุข้อผิดพลาดที่สอดคล้องกัน ใช้หน้านี้เพื่อเข้าใจประเภทข้อผิดพลาดทั่วไป รหัสสถานะ HTTP และข้อความตัวอย่างที่ส่งคืนโดย API.
การเข้าถึง API ขณะนี้มีให้บริการสำหรับแผน Studio ขึ้นไป.
ภาพรวม
เมื่อคำขอล้มเหลว VIDIO API จะส่งคืนวัตถุ error ที่มี type และ message ข้อผิดพลาดบางประเภทอาจมีฟิลด์เพิ่มเติมเพื่อช่วยอธิบายความล้มเหลว.
รูปแบบข้อผิดพลาด
json
{
"error": {
"type": "invalid_request_error",
"message": "ไม่พบบริการงาน"
}
}เอกสารอ้างอิงข้อผิดพลาด
| Status | Type | Message | Description |
|---|---|---|---|
| 400 | invalid_request_error | พารามิเตอร์ query ที่จำเป็นในคำขอ URL การอัปโหลดหายไป | ส่งกลับเมื่อพารามิเตอร์ query ที่จำเป็นหายไปจากคำขอ URL การอัปโหลด |
| 400 | invalid_request_error | ไม่พบ job_id | ส่งกลับเมื่อคำขอเรนเดอร์ไม่มี job ID |
| 400 | invalid_request_error | ไม่พบเอาต์พุตสำหรับงานนี้ | ส่งกลับเมื่องานไม่มีเอาต์พุตที่สามารถเรนเดอร์ได้ |
| 400 | invalid_request_error | input_keys ต้องเป็นอาร์เรย์ที่ไม่ว่าง | ส่งกลับเมื่อ `input_keys` หายไปหรือเป็นค่าว่าง |
| 400 | invalid_request_error | input_keys ต้องประกอบด้วย input key ที่ถูกต้องอย่างน้อยหนึ่งรายการ | ส่งกลับเมื่อ input keys ที่ให้มาทั้งหมดเป็นค่าว่างหรือไม่ถูกต้องหลังการทำ normalization |
| 400 | input_duration_requirement_error | ความยาวรวมของสื่ออินพุตต้องมากกว่า 2 วินาที | ส่งกลับเมื่อความยาวรวมของสื่ออินพุตทั้งหมดเท่ากับหรือไม่เกิน 2 วินาที |
| 400 | input_duration_requirement_error | ความยาวรวมของสื่ออินพุตต้องน้อยกว่า 6 ชั่วโมง | ส่งกลับเมื่อความยาวรวมของสื่ออินพุตทั้งหมดเท่ากับหรือมากกว่า 6 ชั่วโมง |
| 400 | input_image_count_requirement_error | จำนวนรูปภาพอินพุตต้องไม่เกิน 4000 | ส่งกลับเมื่อจำนวนรูปภาพอินพุตเกินขีดจำกัดสูงสุดที่อนุญาต คือ 4000 |
| 400 | input_video_count_requirement_error | จำนวนวิดีโออินพุตต้องไม่เกิน 400 | ส่งกลับเมื่อจำนวนวิดีโออินพุตเกินขีดจำกัดสูงสุดที่อนุญาต คือ 400 |
| 400 | invalid_request_error | video_category ไม่ถูกต้อง ค่าอนุญาต: podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others | ส่งกลับเมื่อ `video_category` ไม่ได้รับการสนับสนุน |
| 400 | invalid_request_error | aspect_ratio ไม่ถูกต้อง ค่าอนุญาต: square, portrait, landscape | ส่งกลับเมื่อ `aspect_ratio` ไม่ได้รับการสนับสนุน |
| 400 | invalid_request_error | output_length ต้องเป็นตัวเลขบวก | ส่งกลับเมื่อ `output_length` หายไป เป็นศูนย์ หรือเป็นค่าลบ |
| 400 | invalid_request_error | ไม่สามารถกำหนดความยาวสื่ออินพุตที่เป็นบวกจากเมตาดาต้าของ input_keys ได้ | ส่งกลับเมื่อ API ไม่สามารถกำหนดความยาวที่ถูกต้องสำหรับสื่ออินพุตที่อัปโหลดได้ |
| 400 | invalid_request_error | music_volume ต้องเป็นตัวเลขระหว่าง 0 ถึง 100 | ส่งกลับเมื่อระบุ `music_volume` แต่ไม่ใช่ตัวเลขที่ถูกต้องระหว่าง 0 ถึง 100 |
| 400 | invalid_request_error | original_audio_volume ต้องเป็นตัวเลขระหว่าง 0 ถึง 100 | ส่งกลับเมื่อระบุ `original_audio_volume` แต่ไม่ใช่ตัวเลขที่ถูกต้องระหว่าง 0 ถึง 100 |
| 400 | invalid_request_error | music_category ไม่ถูกต้อง ค่าอนุญาต: corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary, trending_vlogs | ส่งกลับเมื่อระบุ `music_category` แต่ไม่ตรงกับหมวดหมู่เพลงที่รองรับ |
| 401 | authentication_error | ไม่มี API key | ส่งกลับเมื่อ header `x-api-key` ไม่ถูกส่งมา |
| 401 | authentication_error | API key ไม่ถูกต้อง | ส่งกลับเมื่อ API key ที่ให้มาไม่ตรงกับคีย์ที่ใช้งานได้ |
| 402 | insufficient_balance | คุณไม่มีเครดิตเพียงพอในการประมวลผลงานนี้ | ส่งกลับเมื่อบัญชีไม่มีเครดิตเพียงพอสำหรับการประมวลผลหรือการเรนเดอร์ |
| 403 | permission_error | คุณไม่มีสิทธิ์เข้าถึงงานนี้ | ส่งกลับเมื่อผู้ใช้ที่ยืนยันตัวตนไม่ได้เป็นเจ้าของงานที่ร้องขอ |
| 403 | permission_error | คุณไม่มีสิทธิ์ในการเรนเดอร์งานนี้ | ส่งกลับเมื่อผู้ใช้ที่ยืนยันตัวตนไม่ได้เป็นเจ้าของงานที่กำลังจะเรนเดอร์ |
| 404 | invalid_request_error | ไม่พบงาน | ส่งกลับเมื่องานที่ร้องขอไม่มีอยู่ |
| 404 | invalid_request_error | ไม่พบผู้ใช้ | ส่งกลับเมื่อไม่สามารถพบระเบียนผู้ใช้ที่ยืนยันตัวตนได้ |
| 429 | rate_limit_error | คำขอมากเกินไป | ส่งกลับเมื่อไคลเอนต์เกินอัตราการร้องขอที่อนุญาตสำหรับ endpoint นี้ ขีดจำกัดปัจจุบันคือ 60 คำขอต่อนาที การจำกัดอัตราจะใช้กับแต่ละ API key โดยใช้ header x-api-key และจะใช้ที่อยู่ IP ของไคลเอนต์เป็นทางเลือกเมื่อไม่มี API key ไคลเอนต์ที่ถึงขีดจำกัดนี้ควรลดความถี่ในการร้องขอและลองใหม่อีกครั้งหลังจากหน้าต่างการจำกัดอัตรารีเซ็ต |
| 429 | rate_limit_error | คุณมีงานที่กำลังทำหรือคิวอยู่แล้ว 10 งาน ซึ่งเป็นจำนวนสูงสุดที่อนุญาต กรุณารอให้งานบางงานเสร็จสิ้นก่อนส่งงานใหม่ | ส่งกลับเมื่อผู้ใช้มีจำนวนงานที่กำลังดำเนินการสูงสุดที่อนุญาตแล้ว ทั้งจากงานที่กำลังรันบนเซิร์ฟเวอร์และงานที่รออยู่ในคิว ขีดจำกัดปัจจุบันคือรวมสูงสุด 10 งานที่กำลังรันหรืออยู่ในคิวต่อผู้ใช้หนึ่งคน การเป็นเจ้าของงานถูกกำหนดโดยการจับคู่ job_id แต่ละรายการบนเซิร์ฟเวอร์ที่คับคั่งและรายการในคิวที่รอกลับไปยัง user_email ของงานนั้น ๆ ไคลเอนต์ที่ถึงขีดจำกัดนี้ควรรอให้งานหนึ่งงานหรือมากกว่านั้นเสร็จสิ้นก่อนที่จะสร้างหรือเรนเดอร์งานใหม่ |
| 500 | api_error | ข้อผิดพลาดการยืนยันตัวตน | ส่งกลับเมื่อการยืนยัน API key ล้มเหลวโดยไม่คาดคิดบนเซิร์ฟเวอร์ |
| 500 | api_error | ข้อผิดพลาดภายในเซิร์ฟเวอร์ | ส่งกลับสำหรับความล้มเหลวที่ไม่คาดคิดด้านเซิร์ฟเวอร์ใน endpoint ของ status, render หรือ highlight reel |
| 500 | server_error | ล้มเหลวในการสร้าง URL สำหรับการอัปโหลด | ส่งกลับเมื่อเซิร์ฟเวอร์ล้มเหลวในการสร้าง signed upload URL |