エラー
VIDIO API は一貫したエラーオブジェクト形式を使用します。このページを使って、一般的なエラータイプ、HTTP ステータスコード、および API が返す例メッセージを理解してください。
APIアクセスは現在、スタジオプラン以上で利用可能です。
概要
リクエストが失敗した場合、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には少なくとも1つの有効な入力キーが含まれている必要があります | 提供されたすべての入力キーが正規化後に空または無効である場合に返されます。 |
| 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がアップロードされた入力の有効な再生時間を判定できない場合に返されます。 |
| 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 | リクエストが多すぎます | エンドポイントの許容リクエストレートをクライアントが超えた場合に返されます。現在の制限は1分あたり60リクエストです。レート制限は主にx-api-keyヘッダーによるAPIキー単位で適用され、APIキーが存在しない場合はクライアントのIPアドレスにフォールバックします。この制限に達したクライアントは、リクエスト頻度を下げ、レート制限ウィンドウがリセットされた後に再試行してください。 |
| 500 | api_error | 認証エラー | サーバー側でAPIキー認証が予期せず失敗した場合に返されます。 |
| 500 | api_error | サーバー内部エラー | status、render、またはhighlight reelのエンドポイントで予期せぬサーバー側の障害が発生した場合に返されます。 |
| 500 | server_error | アップロードURLの生成に失敗しました | サーバーが署名付きアップロードURLを生成できなかった場合に返されます。 |