ข้อผิดพลาด
VIDIO API ใช้รูปแบบวัตถุข้อผิดพลาดที่สอดคล้องกัน ใช้หน้านี้เพื่อเข้าใจประเภทข้อผิดพลาดทั่วไป รหัสสถานะ HTTP และข้อความตัวอย่างที่ส่งคืนโดย API.
การเข้าถึง API ขณะนี้มีให้บริการเฉพาะสำหรับแผน Enterprise เท่านั้น กรุณาขอการเข้าถึง ที่นี่ หากคุณไม่ใช่ผู้ใช้ Enterprise แต่สนใจในการใช้ API.
ภาพรวม
เมื่อคำขอล้มเหลว 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 | ส่งคืนเมื่อคำขอเรนเดอร์ไม่มีรหัสงาน. |
| 400 | invalid_request_error | ไม่มีผลลัพธ์สำหรับงานนี้ | ส่งคืนเมื่อไม่มียอดเรนเดอร์สำหรับงาน. |
| 400 | invalid_request_error | input_keys ต้องเป็นอาร์เรย์ที่ไม่ว่าง | ส่งคืนเมื่อ `input_keys` หายไปหรือว่าง. |
| 400 | invalid_request_error | input_keys ต้องมีอย่างน้อยหนึ่งคีย์ที่ถูกต้อง | ส่งคืนเมื่อคีย์ที่ให้ทั้งหมดว่างเปล่าหรือไม่ถูกต้องหลังจากการทำให้เป็นมาตรฐาน. |
| 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 | ไม่สามารถกำหนดระยะเวลาเชิงบวกจาก metadata input_keys ได้ | ส่งคืนเมื่อ API ไม่สามารถกำหนดระยะเวลาที่ถูกต้องสำหรับการอัปโหลดข้อมูล. |
| 401 | authentication_error | ขาด API key | ส่งคืนเมื่อไม่มีการให้ header `x-api-key`. |
| 401 | authentication_error | API key ไม่ถูกต้อง | ส่งคืนเมื่อ 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 | มีคำขอเกินไป | ส่งคืนเมื่อไคลเอนต์เกินอัตราการร้องขอที่ได้รับอนุญาตสำหรับจุดสิ้นสุด ขีดจำกัดปัจจุบันคือ 60 คำขอต่อนาที การควบคุมอัตราจะถูกใช้เป็นหลักต่อ API key โดยใช้ header x-api-key และจะใช้งาน IP address ของไคลเอนต์เมื่อไม่มี API key การควบคุมอัตราจะถูกนำไปใช้เมื่อไคลเอนต์ถึงขีดจำกัดนี้ควรลดความถี่ของคำขอและลองใหม่หลังจากที่หน้าต่างควบคุมอัตรารีเซ็ต. |
| 500 | api_error | ข้อผิดพลาดในการพิสูจน์ตัวตน | ส่งคืนเมื่อการพิสูจน์ตัวตนด้วย API key ล้มเหลวอย่างไม่คาดคิดที่เซิร์ฟเวอร์. |
| 500 | api_error | ข้อผิดพลาดภายในเซิร์ฟเวอร์ | ส่งคืนสำหรับความล้มเหลวที่ไม่คาดคิดบนเซิร์ฟเวอร์ด้านสถานะ การเรนเดอร์ หรือจุดสิ้นสุดไฮไลท์. |
| 500 | server_error | ไม่สามารถสร้าง URL การอัปโหลดได้ | ส่งคืนเมื่อเซิร์ฟเวอร์ไม่สามารถสร้าง URL การอัปโหลดที่ลงนามได้. |