Skip to main content
OpenAI Tasks API は、以前に コールバックモード で OpenAI 画像インターフェースに送信されたタスクの結果を照会するために使用されます。同期 HTTP 応答を待つことができない場合や、後でタスクを再度照会したい場合は、このインターフェースを使用してください。 コールバックモードでは、元の画像インターフェースはリクエストを受理した後、すぐに task_id を返します。この task_id を直接保持し、必要に応じてこのインターフェースで照会することができます。カスタム trace_id を追加で渡す必要はありません(自社のビジネス識別子で関連付けたい場合のみ必要です)。
元の画像リクエストに callback_url が含まれている場合にのみ、タスクは永続化されます。同期(非コールバック)方式で呼び出されたリクエストは保存されません。

申請プロセス

OpenAI Tasks API は、既存の OpenAI サービスと共通の認証を使用します。すでに OpenAI Images Generations を申請している場合は、追加の申請なしで同じトークンを使用してこのインターフェースを呼び出すことができます。 新しいユーザーは初回申請時に無料枠があります。

インターフェースアドレス

サポートされている action:

リクエストヘッダー

  • accept: application/json
  • authorization: Bearer {token}
  • content-type: application/json

単一タスク照会(retrieve)

リクエストボディ

id と trace_id のいずれかを少なくとも1つ渡す必要があります。一般的には、提出応答内の id を直接使用することができます。trace_id は、自社のビジネス識別子で関連付けたい場合にのみ渡してください。

コード例

CURL

Python

返却例

タスクが存在する場合:
一致するタスクが見つからない場合は空のオブジェクトを返します:

フィールド説明

  • id:元の画像リクエスト受理時に生成されたタスク ID。
  • trace_id:元のリクエストで渡されたカスタム追跡識別子、クライアントビジネスの関連付けに便利。
  • type:タスクの種類。gpt-image シリーズ(例:gpt-image-2)で書き込まれたタスクは images;gpt-image-1、nano-banana などは images_generations / images_edits、一部のチャットインターフェースは chat_completions_image。
  • request:元のリクエストの完全なリクエストボディ。
  • response:コールバック完了時に返される最終応答ボディ。
  • created_at / started_at / finished_at:Unix タイムスタンプ(秒、浮動小数点)。
  • elapsed:実行時間(秒、浮動小数点)。
  • application_id / user_id / credential_id:所属アプリ、エンドユーザー、資格情報 ID。

バッチ照会(retrieve_batch)

リクエストボディ

ids / trace_ids / application_id / user_id または created_at_* の時間ウィンドウのいずれかを渡す必要があります。

CURL 例

返却例

エンドツーエンドの例:提出とポーリング

Tasks API は主にコールバックモードでの非同期プロセスにサービスを提供します。コールバックモードでは、提出インターフェースが即座に task_id(すなわちタスクID)を返します。その後は、この task_id を使って Tasks インターフェースをポーリングするだけで、trace_id を自分で生成する必要はありません。

注意事項

  • Tasks インターフェース自体は課金されませんので、安心してポーリングできます。元の画像生成/編集リクエストのみが課金されます。
  • 元のリクエストに callback_url が含まれている場合のみ、タスク記録が書き込まれます;同期呼び出しはクエリ可能なタスクを生成しません。
  • プラットフォームの保持期間を超えたタスク記録は削除される可能性があります。