ข้อผิดพลาด

Reigniter API ใช้รหัสสถานะมาตรฐานHTTPทุกการตอบสนองข้อผิดพลาดเป็นJSON

เนื้อหาข้อผิดพลาด

ข้อผิดพลาดส่วนใหญ่จะมีลักษณะดังนี้:

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

สนาม	มีอยู่เสมอ	มันคืออะไร
error	ใช่	ข้อความที่คุณสามารถแสดงให้บุคคลเห็นได้ข้อความอาจเปลี่ยนไปได้ ดังนั้นอย่าจับคู่กับข้อความนั้น
code	ข้อผิดพลาดมากที่สุด	รหัสตัวพิมพ์ใหญ่ที่เสถียรสาขานี้แหละ
details	ข้อผิดพลาดบางประการ	ข้อมูลเพิ่มเติม เช่น ตัวเลข retryAfter หรือการใช้งาน
retryAfter	บาง 429s	รอแค่ไม่กี่วินาทีก่อนจะลองใหม่

ข้อผิดพลาดบางตัวไม่มี code เช่น 404 Job not found และ 403 Forbidden ให้ branch สถานะสําหรับข้อผิดพลาดเหล่านั้น

ข้อผิดพลาดในการตรวจสอบความถูกต้อง

เมื่อเนื้อหาคําขอไม่ตรงกับสคีมา คุณจะได้ 400 ที่มีสตริง detail ที่แสดงปัญหาทั้งหมดเป็น field: message:

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

รหัสสถานะ

สถานะ	ความหมาย	ควรทําอย่างไร
200	สําเร็จ
201	สร้างแล้ว (webhooks)
202	รับทราบการเรนเดอร์เริ่มแล้ว	โพลงานหรือรอ webhook
400	คําขอถูกปฏิเสธไม่มีการเรียกเก็บเงินใด ๆ	แก้ไขคําขออย่าลองใหม่โดยไม่เปลี่ยนแปลง
401	กุญแจหาย ไม่ถูกต้อง หรือถูกเพิกถอนAPI	ตรวจสอบกุญแจ
402	ปัญหาแผน เครดิต หรือการใช้งาน	อ่าน code
403	บัญชีถูกระงับ หรืองานที่ไม่ใช่ของคุณ	ติดต่อฝ่ายสนับสนุน หรือตรวจสอบรหัสงาน
404	ไม่พบ	ตรวจสอบ ID หรือ path
409	คําขอซ้ําหรือถึงขีดจํากัดแล้ว	อ่าน code
413	การเรนเดอร์นี้จะมีค่าใช้จ่ายสูงกว่าขีดจํากัดต่อการเรนเดอร์	ใช้ฉากน้อยลงหรือ qualityต่ําลง
422	การเรนเดอร์ไม่มีแบรนด์ ผลิตภัณฑ์ หรือผู้นําเสนอมายึดมันไว้	ดูที่ การสร้างวิดีโอ
429	คําขอมากเกินไปหรือเรนเดอร์มากเกินไปพร้อมกัน	รอและลองใหม่ดูที่ Limits
500	ฝั่งเรามีอะไรผิดพลาด	ลองใหม่ทีหลัง
502	การวางแผนจากบรีฟของคุณล้มเหลวเครดิตการวางแผนถูกคืนเงิน	ลองใหม่ หรือเขียนคําใหม่ในบรีฟ
503	การแสดงผลถูกหยุดชั่วคราวหรือบริการล่มไม่มีการเรียกเก็บเงินใดๆ	ลองใหม่ทีหลัง

เส้นทางที่ไม่ทราบภายใต้ /v1/ จะคืนค่า 404 พร้อม code: "NOT_FOUND".

รหัสข้อผิดพลาด

การตรวจสอบสิทธิ์และแผนงาน

โค้ด	สถานะ	ความหมาย
NO_API_KEY	401	ไม่มีส่วนหัว Authorization หรือโทเค็นไม่ขึ้นต้นด้วย emp_
INVALID_API_KEY	401	กุญแจนั้นไม่ทราบหรือถูกเพิกถอน
PLAN_UPGRADE_REQUIRED	402	API เข้าถึงต้องใช้แผนAgency
ACCOUNT_SUSPENDED	403	บัญชีถูกระงับ

เครดิตและการใช้งาน

โค้ด	สถานะ	ความหมาย
NO_CREDITS	402	บัญชีไม่มีเครดิตเหลือแล้ว
INSUFFICIENT_CREDITS	402	เครดิตไม่พอสําหรับการเรนเดอร์นี้
ABUSE_CAP_EXCEEDED	402	ขีดจํากัดการใช้งานรายเดือนของแผนถูกใช้เต็มแล้ว
STORAGE_FULL	402	คลังวิดีโอของบัญชีเต็มแล้วลบวิดีโอบางส่วนออก
UPGRADE_REQUIRED	402	วิดีโอต้องการแผนแบบเสียเงิน
REQUEST_COST_TOO_HIGH	413	การเรนเดอร์ครั้งนี้จะมีค่าใช้จ่ายมากกว่าขีดจํากัดต่อการเรนเดอร์

ดูที่ บัญชีและการเรียกเก็บเงิน สําหรับเครดิตและแผน

การร้องขอเรนเดอร์

โค้ด	สถานะ	ความหมาย
CONTENT_BLOCKED	400	บรีฟหรือฉากนั้นละเมิดกฎเนื้อหา
PRODUCT_IMAGE_REQUIRED	400	รูปแบบนี้ต้องการ product_image_url หรือ product_enabled: false.
PRESENTER_REQUIRED	400	ฉากพูดไม่มีหน้าเพิ่ม avatar_preset_id หรือส่ง presenter_enabled: false
UNSUPPORTED_MODEL	400	ฉากหนึ่งขอโมเดลเรนเดอร์ Reigniter ไม่สามารถใช้งานได้
BRAND_REQUIRED	422	มีการขอยี่ห้อแต่ไม่พบส่ง brand_logo_url
NO_ANCHOR	422	ไม่มีแบรนด์ รูปภาพสินค้า หรือผู้นําเสนอเพิ่มหนึ่ง หรือเลือกไม่เข้าร่วม
CANVAS_NOT_FOUND	404	โครงการที่อ้างอิงจะไม่อยู่ในบัญชีนี้
DUPLICATE_REQUEST	409	Idempotency-Keyนี้ถูกใช้ไปแล้วไม่มีอะไรใหม่ถูกเก็บเงิน
PLAN_FAILED	502	การวางแผนจากบรีฟล้มเหลวเครดิตการวางแผนได้รับการคืนเงิน

ด้วย brief, การ Idempotency-Key ซ้ํา ๆ ก็อาจกลับมาเป็น 402 พร้อมข้อความ This request was already submittedถือว่าเป็นสําเนา ไม่ใช่ปัญหาเครดิต

อัตราและการทํางานพร้อมกัน

โค้ด	สถานะ	ความหมาย
RATE_LIMITED	429	คําขอมากเกินไปรอสัก retryAfter (หรือ details.retryAfterวินาที)
CONCURRENT_LIMIT	429	เรนเดอร์หลายอันกําลังรันพร้อมกันมากเกินไปรอให้อันหนึ่งเสร็จก่อน

การปฏิบัติหน้าที่

โค้ด	สถานะ	ความหมาย
USAGE_CHECK_UNAVAILABLE	503	ไม่สามารถตรวจสอบการใช้งานได้ จึงหยุดการแสดงผลไม่มีการเรียกเก็บเงินใด ๆ
DB_UNAVAILABLE	503	บริการนี้ไม่สามารถใช้งานได้ชั่วคราว
FEATURE_NOT_AVAILABLE	503	ขณะนี้ยังไม่สามารถเรนเดอร์ได้
GLOBAL_KILL_SWITCH	503	การเรนเดอร์จะถูกหยุดชั่วคราวสําหรับทุกคน
FEATURE_KILL_SWITCH	503	ฟีเจอร์นี้ถูกหยุดชั่วคราว
USER_KILL_SWITCH	503	บัญชีนี้ถูกจํากัดชั่วคราวติดต่อฝ่ายสนับสนุน

เว็บฮุค

โค้ด	สถานะ	ความหมาย
UNKNOWN_EVENT	400	ไม่ใช่กิจกรรมที่คุณสามารถสมัครสมาชิกได้คําตอบระบุรายการที่ถูกต้อง
URL_NOT_DELIVERABLE	400	URL ไม่ใช่ที่อยู่ http(s) สาธารณะ
HOOK_LIMIT	409	บัญชีนี้มีจํานวนเว็บฮุกสูงสุดแล้ว

ลองใหม่อย่างปลอดภัย

• ลอง 429, 500, 502 และ 503 ใหม่โดยถอยหลังอย่าลอง 4xx อื่นโดยไม่เปลี่ยนแปลง
• ส่ง Idempotency-Key``POST /v1/render เสมอ
• ไม่มีการตอบสนองเลย (หมดเวลาหรือการเชื่อมต่อหลุด): ลองใหม่ด้วยคีย์ เดิม ถ้าคําขอแรกเริ่มเรนเดอร์ การลองใหม่จะถูกปฏิเสธแทนที่จะเริ่มคําขอที่สอง
• คําตอบข้อผิดพลาด: ไม่มีการเริ่มเรนเดอร์สําหรับคําขอนั้นแก้ไขสาเหตุ แล้วลองใหม่ด้วยคีย์ ใหม่ เพราะคําขอที่ล้มเหลวบางส่วนอาจใช้คีย์ไปแล้วเครดิตการเรนเดอร์จะได้รับคืนค่าธรรมเนียมเดียวที่ไม่ได้รับคืนคือการวางแผนสั้น ๆ เมื่อการเรนเดอร์ที่วางแผนไว้ถูกปฏิเสธ (ดู การสร้างวิดีโอ)
• ถ้างานเรนเดอร์ได้รับการยอมรับ (202) และล้มเหลวในภายหลัง status ของงานจะกลายเป็น failed และ error จะบอกเหตุผลเครดิตสําหรับงานที่ไม่ได้เกิดขึ้นจะถูกคืนเงิน