Skip to main content

クイックスタート

ネイティブ画像エンドポイントはデフォルトで同期です。Boolean の async を true にするとバックグラウンドタスクになります。例では qwen-image-2.0 を使用します。

非同期メディアモデルを見つけて Schema を取得する方法

ディスカバリーは 2 段階です。まず、公開モデルカタログから非同期 API に対応する画像生成または動画生成モデルを取得します。次に、モデルの model_id を使って、そのエンドポイントのリクエスト Schema を取得します。

非同期 API 対応モデルの一覧を取得する

モデルカタログは Playground と同じデータソースを使用します。画像生成モデルには type=image_generation、動画生成モデルには type=video を指定します。schema_checked=true を追加すると、リクエスト Schema が公開され、確認済みのモデルだけが返されます。
どちらも同じ API を使用します。現在、type フィルターは 1 つの値を受け付けるため、モデルタイプごとにリクエストしてください。 レスポンスの形は {success, message, data} です。非同期メディア連携に関連する data のフィールドは次のとおりです。

1 つのモデルのリクエスト Schema を取得する

対応するフィールド、列挙値、数値範囲はモデルごとに異なります。画像または動画のリクエストを送信する前に、次の公開 API で対象モデルの利用可能なエンドポイントとリクエスト JSON Schema を取得してください。
レスポンスの modality は image または video です。endpoints 配列の各項目が、利用可能な呼び出しプロトコルを示します。 同じモデルで /ai/v1 エンドポイントと OpenAI 互換の /v1 エンドポイントが返される場合があります。OpenAI 互換エンドポイントは最新モデルにまだ対応していない可能性があるため、/ai/v1 エンドポイントを優先してください。非同期タスク API では、path が /ai/v1/images/generations または /ai/v1/videos の項目を選び、その request.schema を使用してください。endpoints 配列内の位置には依存しないでください。 次のコマンドで、各非同期タスクエンドポイントのリクエスト Schema を直接抽出できます。
モデルが存在しない、または公開可能なエンドポイントがない場合は 404 model_not_found が返されます。エンドポイントデータを一時的に取得できない場合は 500 endpoints_unavailable が返されます。

画像タスクを作成する方法

同期画像

async を省略するか false に設定すると、API は生成が完了するまで待機し、タスクオブジェクトを返します。
同期画像タスクもタスクレコードとして保存されます。クライアント接続が中断した場合や作成レスポンスを失った場合は、GET /ai/v1/images で該当タスクを検索できます。

非同期画像

async をブール値 true に設定すると、API はすぐにタスクオブジェクトを返し、生成処理はバックグラウンドで続行されます。
非同期画像タスクは GET /ai/v1/images/{id} で照会します。完了後は、各 output 項目の content_url を直接リクエストしてください。この URL には、該当画像の result_id が含まれています。
画像リクエストの async はブール値でなければなりません。webhook_url と webhook_events_filter は async: true と組み合わせた場合にのみ使用できます。

画像の標準フィールド


メディアタスクオブジェクト

画像と動画の専用 API は、次の構造を返します。
メディアの output 項目:

ステータスの説明

クライアントは、ステータスが completed、failed、cancelled のいずれかになるまで、15 秒ごとに照会できます。15 秒はクライアント側の推奨ポーリング間隔であり、サーバープロトコルの制限ではありません。

メディアタスクを照会する方法

メディア詳細の照会

メディア詳細 API は更新後のタスクステータスを返す場合があるため、メディアのポーリングには該当する画像または動画の詳細 API を使用してください。

メディア一覧の照会

作成レスポンスを失った場合は、該当するメディア一覧からタスク ID を取得できます。
メディア一覧は照会時点のタスクスナップショットを返し、タスクステータスを能動的に更新することはありません。

統一タスク API を使用する方法

統一タスク API では、次の条件で絞り込めます。
統一タスクの詳細:
メディアタスクの統一 output 項目:
単一成果物の場合は /ai/v1/tasks/{id}/content を直接リクエストします。複数成果物のタスクでは /ai/v1/tasks/{id}/content/{result_id} をリクエストする必要があり、結果 ID を指定しない場合は 400 result_id_required が返されます。
統一タスクの一覧、詳細、コンテンツ API は、タスク作成時の Bearer Token ごとに分離されています。同じアカウントの別の API Key からは、このタスクを読み取れません。

メディア結果をダウンロードする方法

画像のダウンロード

画像の完了後、メディアタスクオブジェクトの output[].content_url を項目ごとにリクエストします。
画像メディアのダウンロードパスは /ai/v1/images/{id}/content/{result_id} です。メディアタスクオブジェクトでは result_id が個別に公開されないため、クライアントは content_url をそのまま使用できます。 b64_json が空でない場合は、このフィールドを直接 Base64 デコードできます。

Webhook を使用する方法

非同期画像と動画は、タスク単位の Webhook に対応しています。
webhook_url は最大 512 文字で、ローカルホスト、プライベートネットワーク、その他の制限対象アドレスを指定することはできません。webhook_events_filter を省略すると、プラットフォームは completed、failed、cancelled を配信します。明示的に渡す場合、配列は空にできず、重複も許可されません。また、webhook_url と一緒に使用する必要があります。 リクエストで webhook_url を渡さなかった場合、非同期画像と動画ではアカウントに設定されたデフォルトのコールバック URL が使用されます。アカウントのデフォルト URL が無効な場合は無視され、タスクの作成は妨げられません。

コールバックリクエスト

results は結果がアーカイブ済みの場合にのみ含まれ、ダウンロードには引き続き Bearer Token が必要です。

リトライと重複排除

プラットフォームは少なくとも 1 回の配信を行うため、同じイベントが複数回届く場合があります。
  • HTTP 2xx は受信成功を示します。
  • HTTP 5xx、ネットワークエラー、タイムアウトの場合は再試行します。
  • HTTP 3xx と 4xx の場合は再試行しません。
  • 配信は最大 6 回で、再試行間隔は順に 1、4、16、64、256 秒です。
受信側は event_id を保存し、同じイベントを再度受信した場合はそのまま 2xx を返してください。
タスク単位の Webhook 自体には、独立した署名キーが含まれません。署名検証が必要な場合は、アカウント単位の Webhook サブスクリプションを設定し、結果の確認手段としてタスク詳細の照会も維持してください。

エラーレスポンスとエラーコード

この節は /ai/v1/images/* と画像タスクに適用されます。動画のエラーは動画 APIをご覧ください。
  • 現在のリクエストの失敗:HTTP が 2xx 以外の場合、今回の作成、照会、ダウンロードに失敗しています。HTTP リクエストの失敗をご覧ください。
  • タスク実行の失敗:照会は HTTP 200 を返しますが、タスクが status=failed となり、理由はタスク内の error に記録されます。タスク実行の失敗をご覧ください。
  • 一覧の個別結果の読み取り失敗:一覧は HTTP 200 を返しますが、一部のタスクに output_error が含まれます。一覧の個別結果の読み取り失敗をご覧ください。
以下の message 列は API が返す英語のメッセージ、説明列は意味と対処方法を示します。パラメータ検証エラーには一般的なメッセージを掲載しており、実際のレスポンスではフィールドや制約が具体的に示される場合があります。エラーの種類は code で判定し、message 全文の完全一致に依存しないでください。

HTTP 5xx エラーの報告

リクエストが HTTP 5xx を返した場合は、error.tid を添えて報告してください。

HTTP リクエストの失敗

以下の HTTP ステータスは、現在のリクエスト自体が失敗した場合に適用されます。作成済みタスクの実行失敗は、後述の「タスク実行の失敗」をご覧ください。

リクエストパラメータとメディア入力

サイズ制限
  • メディアサイズ:画像タスクで上限を超えると image_too_large が返されます。具体的な上限はエラーメッセージまたは error.details.max_bytes を確認してください。
  • リクエスト全体のサイズ:request_too_large は、テキスト、パラメータ、インラインのエンコード済みメディアを含む HTTP 本文が 32 MiB を超えたことを示します。URL のみを送信する場合、リンク自体が本文に含まれます。リンク先のファイルには引き続きモデルのメディア制限が適用されます。
  • 実際のサイズ:error.details.actual_bytes は全体のサイズが確認できた場合にのみ含まれます。URL からの読み取りが上限に達して停止した場合、このフィールドが省略されることがあります。
対応形式 選択したモデルによって異なります。まず error.details.allowed_mime_types またはエラーメッセージの形式一覧を確認してください。一覧がない場合はモデルの Schema を参照してください。 メッセージ内のプレースホルダー
  • {media_kind}:実際のメディアの種類。種類が確認できている場合、invalid_media_data と media_url_unreachable のメッセージでも image または video が使われます。
  • {max_bytes}:バイト単位の上限。画像の上限が不明な場合は The image is too large. Reduce the image size and try again. が返されます。
  • {allowed_formats}:許可される形式の一覧。形式エラーのメッセージに Use one of: {allowed_formats}. が追加される場合があります。

生成リクエストと返された結果

アカウントと権限

サービスの可用性とレート制限

provider_unavailable は、モデルプロバイダーの障害が明確に確認されたことを示します。一般的な 429 や 4xx だけでは、利用枠、コンテンツ審査、パラメータの問題を特定できません。

タスクの照会と結果のダウンロード

タスク実行の失敗

タスク作成後の生成失敗は status=failed とタスク内の error で示されます。照会が成功した場合の HTTP ステータスは 200 のままです。
メディア入力エラーは失敗した Task にも含まれる場合があり、コードの意味は上の入力エラー表と同じです。この場合も照会成功時の HTTP ステータスは 200 です。サイズエラーの message は submit a new task. で終わり、メディアを縮小して新しいタスクを送信するよう案内します。 output_blocked は、明確なブロックが発生し、利用可能な画像が返されなかったことを示します。今回の生成料金は発生しません。output_policy_violation には既存のコンテンツ審査に関する課金ルールが適用されます。過去の料金は請求記録で確認してください。

一覧の個別結果の読み取り失敗

画像・動画タスク一覧の一部の行に output_error が含まれる場合があります。
このフィールドは、今回その行の結果を読み取れなかったことを示します。一覧は HTTP 200 を返し、その行は output=[] になります。元の id、status、error とページネーションは変わらず、正常に読み取れる他のタスクに影響しません。status=completed でも output_error を確認し、結果を読み取れるか判断してください。 output_error.tid を添えてサポートに連絡してください。tid がない場合は今回のレスポンスヘッダーのリクエスト ID を提供できます。このエラーはタスクの状態や料金を変更せず、Webhook も発生させません。 画像・動画の一覧では取得済みの expires_at が保持されます。統一 /ai/v1/tasks 一覧の読み取り失敗行は expires_at=null を返す場合がありますが、元の保存期間は引き続き適用されます。 この処理は、個別の行の結果を読み取れず、利用できる代替手段がない場合に限ります。統一 tasks API で一覧全体の照会が失敗すると HTTP エラーが返され、詳細取得で同じ障害が起きた場合は HTTP 500 が返されます。 関連ドキュメント:画像 API · 動画 API · 非同期タスク

完全な例

非同期タスクを作成し、ポーリングして、返された画像をすべて保存します。