錯誤
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 | 上傳 URL 請求中缺少必要的查詢參數 | 當上傳 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 必須至少包含一個有效的輸入鍵 | 當所有提供的輸入鍵在正規化後皆為空白或無效時返回。 |
| 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 的 metadata 判定正確的輸入時長 | 當 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 金鑰 | 當未提供 `x-api-key` 標頭時返回。 |
| 401 | authentication_error | API 金鑰無效 | 當提供的 API 金鑰與任何有效金鑰不符時返回。 |
| 402 | insufficient_balance | 您的點數不足以處理此工作 | 當帳戶沒有足夠點數進行處理或渲染時返回。 |
| 403 | permission_error | 您沒有權限存取此工作 | 當已驗證的使用者並非該請求工作之擁有者時返回。 |
| 403 | permission_error | 您沒有權限渲染此工作 | 當已驗證的使用者並非正在渲染之工作的擁有者時返回。 |
| 404 | invalid_request_error | 找不到工作 | 當請求的工作不存在時返回。 |
| 404 | invalid_request_error | 找不到使用者 | 當已驗證的使用者資料無法找到時返回。 |
| 429 | rate_limit_error | 請求過多 | 當客戶端超過該端點允許的請求速率時返回。當前限制為每分鐘 60 次請求。速率限制主要依據 `x-api-key` 標頭的 API 金鑰實施,若未提供 API 金鑰則改以客戶端 IP 位址為準。達到此限制的客戶端應降低請求頻率,並在速率限制視窗重置後重試。 |
| 429 | rate_limit_error | 您已經有 10 個運行中或排隊中的工作,這是允許的最大數量。請等候部分工作完成後再提交新的工作。 | 當使用者在伺服器上的執行中工作與佇列中的待處理工作總數已達允許的最大進行中工作數時返回。當前限制為每位使用者最多 10 個運行中或排隊中的工作。工作所有權是透過比對忙碌伺服器與待處理佇列項目的每個 job_id 到該工作的 user_email 來判定。達到此限制的用戶應等候一或多個現有工作完成後,再建立或渲染新的工作。 |
| 500 | api_error | 驗證錯誤 | 當伺服器端 API 金鑰驗證意外失敗時返回。 |
| 500 | api_error | 內部伺服器錯誤 | 當 status、render 或 highlight reel 等端點發生意外的伺服器端失敗時返回。 |
| 500 | server_error | 產生上傳 URL 失敗 | 當伺服器無法生成簽名的上傳 URL 時返回。 |