OpenAI Responses

OpenAI互換のResponses APIを使用して、テキスト、画像、ツール呼び出し、推論のレスポンスを作成します。

Responses APIは、テキスト、画像、ファイル、ツール呼び出し、推論出力をTyped Itemsとして表現します。マルチモーダル入力、組み込みツール、ステートフルな対話、セマンティックストリーミングイベントを必要とするアプリケーションに適しています。利用できる項目タイプ、ツール、高度なフィールドは、選択したモデルによって異なります。

POST/v1/responses

テキスト、画像、ファイル、または Typed Input Items からモデルレスポンスを作成します。この API は、メッセージ、推論項目、ツール呼び出しなどの Output Items を返し、SSE によるセマンティックイベントの配信にも対応します。

画像、組み込みツール、推論、ステートフルな対話、構造化出力への対応は、現在のアカウントで利用できるモデルとアップストリームチャネルによって異なります。まず最小限のテキストリクエストを確認し、その後で高度なフィールドを 1 つずつ有効にすることを推奨します。

認証

bearerAuth

認証Bearer <token>

Authorization Header に Bearer your-api-key を指定します。

指定位置: header

リクエストボディ

Responses では、入力、ツール、出力を Typed Items で表現します。用途に応じて表示を選択してください。利用できるフィールドはモデルとプロバイダーチャネルによって異なります。

application/json

テキスト入力

最短の方法では input に文字列を直接渡します。メッセージ形式の Typed Items も使用できます。

model: 現在の API キーで利用できる Responses 対応モデル ID です。
input: 文字列または Typed Input Items の配列です。
instructions: 今回のレスポンスだけに適用される上位指示です。

application/json

{
  "model": "MODEL_ID",
  "input": "3 文で自己紹介してください。"
}

基本的なテキストレスポンスです。input には文字列または Typed Input Items を指定できます。

background?boolean|null

レスポンスをバックグラウンドで実行するかどうかです。バックグラウンドモードの利用可否は、モデル、チャネル、アカウント権限によって異なります。

デフォルト値false

context_management?array<>|null

指定した Token しきい値に到達した際の圧縮など、現在のリクエストに対するコンテキスト管理設定です。

conversation?string||null

このレスポンスが属する Conversation です。Conversation ID または id を含むオブジェクトを指定できます。previous_response_id とは同時に使用できません。

model?string

使用する Responses テキストモデル ID です。現在の API キーで利用できるモデルを選択してください。

長さ1 <= length

input?text input|array<||||||||||||||||||||||||||||||>

テキスト入力です。文字列を直接渡すか、メッセージやその他の Typed Items を指定します。

include?array<>|null

レスポンスに追加する拡張データを指定します。

instructions?string|array<||||||||||||||||||||||||||||||>|null

このレスポンスに対する上位指示として使用する system または developer メッセージです。previous_response_id を使用しても、前のレスポンスの instructions は自動的に継承されません。

max_output_tokens?integer|null

レスポンスで生成できる Token の上限です。表示される出力と推論 Token を含みます。

max_tool_calls?integer|null

このレスポンスで処理できる組み込みツール呼び出しの合計上限です。ツールの種類ごとの上限ではありません。

範囲0 <= value

metadata?|null

レスポンスオブジェクトに付加するキーと値の情報です。キーは最大 64 文字、値は最大 512 文字です。

プロパティ数properties <= 16

parallel_tool_calls?boolean|null

モデルがツール呼び出しを並列実行できるかどうかです。

デフォルト値true

moderation?|null

レスポンスの入力と出力に対するモデレーション設定です。

previous_response_id?string|null

ステートフルな対話を継続するための、前の Response の一意な ID です。conversation とは同時に使用できず、前のレスポンスの instructions は自動的に継承されません。

prompt?|null

保存済み Prompt テンプレートとその変数参照です。

prompt_cache_key?string|null

類似リクエストのプロンプトキャッシュヒット率を高め、user のキャッシュ用途を置き換えるために使用します。

prompt_cache_options?|null

リクエスト単位のプロンプトキャッシュ設定です。コンテンツブロックでは prompt_cache_breakpoint を使用して明示的なキャッシュ境界を指定できます。

prompt_cache_retention?string|null

非推奨

非推奨です。prompt_cache_options.ttl を使用してください。このフィールドは旧キャッシュ保持ポリシーとの互換性のために残されています。

指定可能な値

"in_memory"
"24h"
null

reasoning?|null

推論モデルの設定です。この機能に対応するモデルにのみ適用されます。

service_tier?string|null

リクエストで使用するサービス階層です。リクエスト値と実際のレスポンス値が異なる場合があります。たとえば fast を指定しても priority が返ることがあります。

デフォルト値"auto"

指定可能な値

"auto"
"default"
"flex"
"scale"
"priority"
"fast"
"ultrafast"
null

safety_identifier?string|null

安全性および不正利用の監視に使用する安定したエンドユーザー識別子です。個人を特定できる情報を送らないよう、事前にハッシュ化することを推奨します。

長さlength <= 64

store?boolean|null

生成したレスポンスを保存するかどうかです。保存、読み取り、保持期間の実際の動作はプラットフォームの対応状況によって異なります。

デフォルト値true

stream?boolean|null

true の場合、Server-Sent Events で Responses のセマンティックイベントを返します。

デフォルト値false

stream_options?|null

ストリーミングレスポンスの設定です。stream が true の場合にのみ使用します。

temperature?number|null

サンプリング温度です。通常は temperature または top_p のどちらか一方のみを調整します。

範囲0 <= value <= 2

デフォルト値1

text?

tool_choice?||||||||

モデルがツールを選択するかどうか、および選択方法を制御します。

tools?array<|||||||||||||>

モデルが使用できる組み込みツールまたはカスタム関数です。実際の対応範囲はモデルとチャネルによって異なります。

top_logprobs?integer|null

各出力 Token 位置で返す最有力候補 Token の数です。0～20 を指定できます。

範囲0 <= value <= 20

top_p?number|null

nucleus sampling の確率質量です。通常は top_p または temperature のどちらか一方のみを調整します。

範囲0 <= value <= 1

デフォルト値1

truncation?string|null

非推奨

コンテキストがウィンドウを超えた場合の切り詰め方式です。disabled の場合、上限を超えたリクエストは失敗します。

デフォルト値"disabled"

指定可能な値

"auto"
"disabled"
null

user?string

非推奨

非推奨です。安全性の識別には safety_identifier、キャッシュのグループ化には prompt_cache_key を使用してください。

Responses のツール、状態、推論、マルチモーダル機能は、モデルとプロバイダーチャネルによって異なる場合があります。まず最小限のテキストリクエストを確認し、その後で高度なフィールドを一つずつ有効にしてください。

レスポンスボディ

`application/json`

curl -X POST "https://example.com/v1/responses" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "input": "ユニコーンが登場する寝る前のお話を 3 文で作ってください。"  }'

{
  "id": "resp_example",
  "object": "response",
  "created_at": 1741476542,
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "model": "MODEL_ID",
  "output": [
    {
      "id": "msg_example",
      "type": "message",
      "status": "completed",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "月明かりの下、1 頭のユニコーンが星空へ続く秘密の小道を見つけました。",
          "annotations": []
        }
      ]
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {
    "effort": null,
    "summary": null
  },
  "store": true,
  "temperature": 1,
  "text": {
    "format": {
      "type": "text"
    }
  },
  "tool_choice": "auto",
  "tools": [],
  "top_p": 1,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 18,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 22,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 40
  },
  "user": null,
  "metadata": {}
}

OpenAI Responses公式ドキュメントアップストリームプロトコルの定義と最新のフィールド変更を確認します。

認証

リクエストボディ

レスポンスボディ

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

502application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`