Skip to main content
POST

认证

string
必須
Bearer Token 認証。フォーマット:Authorization: Bearer <api-key>API Key を取得するには:API Key 管理ページ にアクセスしてください
string
代替認証方式。Authorization と併用不可。フォーマット:x-api-key: <api-key>

リクエストボディパラメータ

string
必須
使用するモデル名。例:gpt-4ogpt-5.4gpt-5.5など。完全なモデル一覧は GET /api/v1/models で取得可能です。
array
必須
入力内容のリスト入力配列で、各入力項目は rolecontent の2つのフィールドを含みます。多輪対話およびマルチモーダルコンテンツ(テキスト+画像)に対応しています。
string
システムプロンプト。モデルの行動規範、役割、文脈を設定するために使用されます。メッセージ配列中の role: "system" メッセージと同等です。
boolean
デフォルト:"true"
ストリーミング出力を有効にするかどうか。
  • true(デフォルト):SSEイベントストリーム方式でトークン単位で返し、リアルタイム表示に適します
  • false:完全な応答を待って一括返却し、一括処理に適します
integer
生成される返信の最大トークン数。制限を超えるとレスポンスの status"incomplete"incomplete_details.reason"max_output_tokens" になります。
number
サンプリング温度、範囲は 02。値が高いほど出力がよりランダムに、値が低いほど決定的になります。temperaturetop_p を同時に変更することは推奨されません。
number
核サンプリング確率、範囲は 01。モデルは累積確率が top_p に達するまでのトークンからのみサンプリングします。
array
モデルが呼び出せるツールのリスト。現在は type: "function" タイプのみサポートし、web_searchfile_searchcomputer_use 等の組み込みツールはサポートしていません。
string | object
デフォルト:"auto"
ツール呼び出しポリシー:
  • "auto": モデルが自動的にツール呼び出しを判断します
  • "none": ツール呼び出しを禁止します
  • "required": 少なくとも1つのツール呼び出しを強制します
  • { "type": "function", "name": "function_name" }: 指定ツールの呼び出しを強制します
boolean
デフォルト:"true"
モデルが複数のツールを並行して呼び出すことを許可するか。tools が提供されている場合に有効です。
object
出力フォーマットの制御。
object
推論モード設定(推論対応モデル、例:gpt-5.2 以上向け)。

レスポンスフィールド

string
レスポンスの一意識別子、形式:resp_ + 24文字のランダム文字列
string
固定値 "response"
number
レスポンス作成時間、Unixタイムスタンプ(秒、ミリ秒精度を含む)
string
レスポンスステータス:
  • "completed":正常に完了
  • "incomplete"max_output_tokens による早期終了
  • "in_progress":ストリーミング出力中(ストリーミングイベントのみ)
  • "failed":生成失敗
string
実際に使用されたモデル名
string
プラットフォーム拡張フィールド。この呼び出しの課金タスクID。照合および消費の照会に使用可能。注意
  • 非ストリーミングtask_id はレスポンスJSONのトップレベルに直接存在
  • ストリーミングtask_idresponse.created(最初のイベント)および response.completed(最後のイベント)内の response オブジェクトにネストされており、元のSSEイベントから解析する必要がある。OpenAI SDK のストリーミングインターフェースはこのフィールドを自動的に公開しない
array
出力コンテンツの配列で、テキストメッセージとツール呼び出しの2タイプを含むことができる。
string
ショートカットフィールドで、output[0].content[0].text と同等(テキストのみのシーン)。ツール呼び出しシーンでは空文字列。
object
トークン使用量の統計。
object | null
status"incomplete" の場合は null ではない。

ストリームレスポンスイベント

stream: true の場合、インターフェースは text/event-stream 形式でSSEイベントストリームを返します。各イベントの形式は以下の通りです:
すべてのイベントペイロードには sequence_number フィールド(0 からインクリメント)が含まれ、クライアントがイベントを順番に処理できるようにします。
task_id の取得:ストリームモードで課金タスクIDを取得するには、最初の response.created イベントを監視し、event.response.task_id を読み取ってください。

イベントシーケンス(テキストレスポンス)

イベントシーケンス(ツール呼び出し)

イベント例


使用例

基本文字対話

画像理解

ツール呼び出し

構造化出力(JSON Schema)

推論モード

複数ターン対話

previous_response_id は現状機能せず、過去のメッセージは input で手動で連結する必要があります:

注意事項

  1. デフォルトでストリーミングstream パラメータはデフォルトで true です。非ストリーミングのレスポンスが必要な場合は、明示的に "stream": false を指定してください。
  2. 残高不足:残高が不足している場合は HTTP 402 が返されます。チャージしてから再試行してください。
  3. text.format のサポートは限定的:現在の基盤プロバイダーは構造化出力のサポートが限定されています。json_object モードではモデルが純粋な JSON ではなく Markdown コードブロックを返す可能性があり、json_schema モードではスキーマ制約が遵守されない場合があります。構造化出力が必要な場合は、instructions または input 内でフォーマットを明確に指定することをお勧めします。
  4. ツールパラメータparameters フィールドは有効な JSON Schema である必要があり、required 配列が必須パラメータを決定します。

エラーコードの説明