メインコンテンツへスキップ
idempotencyKey は送信時に任意で指定する文字列です。同じキーで再度送信すると、1回目の送信で作成されたタスクが返ります。新しい作業はキューに入らず、新しいクレジットの確保も行われません。
キーがなければ重複排除は行われず、送信のたびに新しいタスクが作られます。cronジョブや再試行するワーカーが2回送信しうるものには、キーを指定してください。
キーは試行ではなく作業単位から作ってください。"{jobId}:{promptId}:{engine}" のようなキーなら、その作業を何度再試行しても同じ値になります。

各エンドポイントでの重複キーの扱い

単発のエンドポイントは明示的な作成のセマンティクスを保ちます。既に存在するタスクの作成を求めたので、競合が返ります。エラーの error.details.taskId に既存タスクの id が入るため、送信応答を受け取れなかった場合もその id で結果を取得できます。
500タスクのバッチは重複を成功として吸収します。そのため、ワーカーが再起動後にジョブ全体を再送信しても、既に入っている項目のせいでバッチが失敗することはありません。

位置グリッド

グリッドの idempotencyKey がそのidになります(省略するとUUIDが生成されます)。各地点のタスクキーは <grid id>:r<row>c<col> です。同じグリッドを同じidで再送信すると、既存の地点が返り、欠けている地点だけが受け付けられます。中心、サイズ、半径の異なるグリッドを同じidで送信すると、座標が異なる地点は RESOURCE_ALREADY_EXISTS で失敗します。新しいグリッドには新しいキーを使ってください。

範囲と長さ

キーの範囲はアカウント単位です。他のアカウントが同じ文字列を使っても、あなたのキーとは衝突しません。 UUID形式である必要はありません。

結果と送信を対応付ける

キーを送信しなかった場合、idempotencyKey は null として返されるのではなく、タスクオブジェクトから省略されます。

キーの有効期間

キーはリクエストから少なくとも30日間予約されたままです。タスクが完了または失敗した後も、24時間のポーリング期間が終わった後も同じです。ポーリングが 404 を返してもキーは解放されません。1回の送信の通信再試行には同じキーを使い、同じ作業の別の実行には新しいキー(例: :r1 サフィックスを付ける)を使ってください。

次のステップ

バッチとグリッド

3つの一括送信エンドポイントの比較。

エラー

すべてのリクエストエラーコード。