誤り

Reigniter APIは標準HTTPステータスコードを使用しています。すべてのエラー応答はJSONです。

誤差体

ほとんどのエラーは次のような形になります:

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

フィールド	常に存在している	それは何か
`error`	はい	人に見せられるメッセージ。表現が変わるかもしれないので、一致しないようにしてください。
`code`	エラーが多い	安定した大文字のコードだ。これに分岐しろ。
`details`	いくつかの誤り	例えば、 `retryAfter` や使用率などの追加の背景情報。
`retryAfter`	いくつかの`429`	再挑戦する前に数秒待つ時間。

codeがないエラーもいくつかあります。例えば404 Job not foundや403 Forbidden。それらのステータスを分岐してください。

検証エラー

リクエスト本体がスキーマと一致しない場合、すべての問題をfield: messageリストするdetail文字列で400されます。

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

ステータスコード

現状	意味	どうすればいいか
`200`	成功。
`201`	作成済み(ウェブフック)。
`202`	受理。レンダリングが始まりました。	ジョブをポーリングするか、ウェブフックを待ちましょう。
`400`	その要請は却下されました。何も起訴されませんでした。	リクエストを修正してください。変更せずに再試行しないでください。
`401`	キーの紛失、無効、または取り消されたキー API 。	鍵を確認して。
`402`	プラン、クレジット、または使用の問題。	読んで `code`。
`403`	アカウント停止、または自分のものではない仕事。	サポートに連絡するか、求人IDを確認してください。
`404`	見つかりません。	IDか経路を確認してください。
`409`	重複リクエストまたは制限に達しました。	読んで `code`。
`413`	このレンダリングは1回のレンダリング制限を超えてコストがかかります。	シーン数を減らしたり、より低くしたり `quality`。
`422`	レンダリングにはブランドも製品もプレゼンターも存在しません。	動画作成を参照してください。
`429`	リクエストが多すぎたり、同時にレンダリングが多すぎたりします。	待ってから再挑戦してください。「限界」を参照してください。
`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	この1回のレンダリングは1回のレンダリング制限を超えてコストがかかります。

クレジットやプランについては「アカウントと請求」をご覧ください。

レンダリングリクエスト

コード	現状	意味
`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もメッセージThis request was already submitted``402として返ってくることがあります。クレジットの問題としてではなく、重複として扱いましょう。

速度と並行処理

コード	現状	意味
`RATE_LIMITED`	429	リクエストが多すぎる。 `retryAfter` 秒(あるいは `details.retryAfter`秒)待て。
`CONCURRENT_LIMIT`	429	同時にレンダリングが多すぎます。1つが終わるまで待ちましょう。

運用

コード	現状	意味
`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。
全く応答なし(タイムアウトや接続切断):同じキーで再試行します。最初のリクエストがレンダリングを開始した場合、2回目のリクエストを開始せずリトライが拒否されます。
エラー応答:そのリクエストに対してレンダリングを開始していません。原因を修正し、途中で失敗したリクエストはすでにそのキーを使っている可能性があるため、 新しい キーで再挑戦してください。レンダリングクレジットは返金されます。返金されない唯一の料金は、計画していたレンダリングが拒否された場合の短期計画費です(動画作成参照)。
もしレンダリングが受け入れられた(202)が後に失敗した場合、その仕事の status は failed となり、 error 理由が説明されます。行われていない作業のクレジットは返金されます。