Chat Completions

OpenAI互換のChat Completions APIを使用して、テキスト、マルチモーダル、ツール呼び出しのレスポンスを作成します。

Chat Completions APIは、メッセージ一覧に基づいてモデルのレスポンスを生成します。通常のテキストチャット、マルチモーダル入力、ストリーミング出力、構造化出力、関数ツール呼び出しに利用できます。利用できる入力形式と高度なパラメータはモデルによって異なるため、現在のAPI Keyで利用可能なモデルと実際の呼び出し結果を確認してください。

POST/v1/chat/completions

指定されたメッセージ一覧からモデルのレスポンスを生成します。このエンドポイントは通常レスポンスと SSE ストリーミングレスポンスに対応します。画像、音声、ツール呼び出し、構造化出力などの高度な機能は、選択したモデルによって異なります。

モデルを切り替える場合は、まず最小限のテキストリクエストで基本機能を確認し、その後で高度なパラメーターを 1 つずつ有効にすることを推奨します。

認証

bearerAuth

認証Bearer <token>

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

指定位置: header

リクエストボディ

モデルの入力モダリティに応じてリクエスト構造を選択します。3 つの表示は同じ Chat Completions エンドポイントを使用し、共通の生成パラメーターも同じです。

application/json

テキストチャット

通常のチャット、コンテンツ生成、テキスト推論に使用します。メッセージ内容には文字列を直接指定できます。

model: 現在のアカウントで利用できるテキストモデル ID です。
messages[].role: メッセージのロールです（例：user、system、assistant）。
messages[].content: 文字列形式のテキストメッセージです。

application/json

{
  "model": "MODEL_ID",
  "messages": [
    {
      "role": "user",
      "content": "こんにちは。1 文で自己紹介してください。"
    }
  ]
}

テキストチャットのリクエストです。ユーザーメッセージには文字列、または text のみを含むコンテンツ配列を使用できます。

model*string

使用するテキストモデル ID です。モデルマーケットから、現在のアカウントで利用でき、テキスト入力に対応するモデル ID をコピーしてください。

長さ1 <= length

messages*array<|||||>

テキストチャットのメッセージ一覧を送信順に指定します。

項目数1 <= items

store?boolean|null

このチャット補完の出力を保存するかどうかです。利用可否は選択したモデルとチャネルによって異なります。

デフォルト値false

reasoning_effort?string|null

推論モデルの推論量です。指定可能な値は選択したモデルによって異なり、none は推論量を明示的に無効にします。

デフォルト値"medium"

指定可能な値

"none"
"minimal"
"low"
"medium"
"high"
"xhigh"
"max"
null

metadata?|null

リクエストに付加するキーと値の情報です。キーは最大 64 文字、値は最大 512 文字です。

プロパティ数properties <= 16

modalities?array<>|null

モデルに生成させる出力タイプです。デフォルトではテキストのみを生成します。

prediction?|null

想定される出力の大部分が既知の場合に使用する予測コンテンツ設定です。

audio?|null

音声出力をリクエストする場合の形式と音声設定です。

temperature?number|null

サンプリング温度です。通常は temperature または top_p のどちらか一方のみを調整します。対応状況は選択したモデルによって異なります。

範囲0 <= value <= 2

デフォルト値1

top_p?number|null

nucleus sampling の確率質量です。通常は temperature または top_p のどちらか一方のみを調整します。対応状況は選択したモデルによって異なります。

範囲0 <= value <= 1

デフォルト値1

n?integer|null

入力ごとに生成する候補レスポンス数です。複数の候補を生成すると使用量が増えます。

範囲1 <= value <= 128

デフォルト値1

stop?string|array<string>|null

最大 4 個の停止シーケンスです。対応状況と具体的な動作は選択したモデルによって異なります。

max_tokens?integer|null

非推奨

旧式の最大出力 Token パラメーターです。max_completion_tokens の使用を推奨します。

範囲1 <= value

max_completion_tokens?integer|null

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

presence_penalty?number|null

Token がすでに出現したかどうかに基づいてペナルティを適用し、新しい話題が登場する可能性を高めます。対応状況は選択したモデルによって異なります。

範囲-2 <= value <= 2

デフォルト値0

frequency_penalty?number|null

Token の出現頻度に基づいてペナルティを適用し、繰り返しを抑えます。対応状況は選択したモデルによって異なります。

範囲-2 <= value <= 2

デフォルト値0

logit_bias?|null

Token ID を -100 から 100 のバイアス値に対応付けます。

logprobs?boolean|null

出力 Token の対数確率を返すかどうかです。対応状況は選択したモデルによって異なります。

デフォルト値false

user?string

非推奨

非推奨のエンドユーザー識別子です。安全監視には safety_identifier、キャッシュルーティングには prompt_cache_key を使用してください。

safety_identifier?string|null

安全性および不正利用の監視に使用する安定したエンドユーザー識別子です。個人情報を含まないハッシュ化された値を推奨します。

長さlength <= 64

prompt_cache_key?string|null

類似リクエストのキャッシュヒット率を高めるための安定したキーです。個人情報やその他の機密情報を含めないでください。

prompt_cache_options?|null

リクエスト単位のプロンプトキャッシュ設定です。

prompt_cache_retention?string|null

非推奨

非推奨のキャッシュ保持設定です。代わりに prompt_cache_options.ttl を使用してください。

指定可能な値

"in_memory"
"24h"
null

verbosity?string|null

テキスト回答の詳細度を制御します。対応状況は選択したモデルによって異なります。

デフォルト値"medium"

指定可能な値

"low"
"medium"
"high"
null

moderation?|null

入力と出力のコンテンツモデレーションポリシーを設定します。

service_tier?string|null

リクエストで使用するサービス階層です。利用可否はアカウントとアップストリームの機能によって異なります。

デフォルト値"auto"

指定可能な値

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

stream_options?|null

stream: true の場合にのみ使用するストリーミングレスポンスオプションです。

response_format?||

モデルの出力形式を指定します。構造化出力の対応状況は選択したモデルによって異なります。

seed?integer|null

非推奨

決定論的サンプリングを可能な範囲で行う Beta パラメーターです。完全な決定性は保証されません。

tools?array<|>

モデルが呼び出せるツールの一覧です。

項目数items <= 128

functions?array<>

非推奨

旧式の関数定義です。代わりに tools の使用を推奨します。

tool_choice?|||

モデルがツールを呼び出すか、指定したツールを強制的に呼び出すか、利用可能なツールを一部に限定するかを制御します。

function_call?|

非推奨

旧式の関数選択パラメーターです。代わりに tool_choice の使用を推奨します。

parallel_tool_calls?boolean

モデルが 1 回のレスポンスで複数のツールを並列に呼び出せるかどうかです。

デフォルト値true

stream?boolean|null

true の場合、Server-Sent Events を使用してチャット補完データチャンクを段階的に返します。

デフォルト値false

top_logprobs?integer|null

各 Token 位置で返す、確率が最も高い Token の数です。使用時は logprobs: true も設定してください。対応状況は選択したモデルによって異なります。

範囲0 <= value <= 20

web_search_options?

画像と音声の入力は、対応するモダリティをサポートするモデルでのみ利用できます。現在のアカウントで利用可能なモデルと実際の API 機能を確認してください。

レスポンスボディ

`application/json`

curl -X POST "https://example.com/v1/chat/completions" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "messages": [      {        "role": "user",        "content": "こんにちは。1 文で自己紹介してください。"      }    ]  }'

{
  "id": "chatcmpl_example",
  "object": "chat.completion",
  "created": 1741569952,
  "model": "MODEL_ID",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "こんにちは。どのようなお手伝いができますか？",
        "refusal": null,
        "annotations": []
      },
      "logprobs": null,
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 19,
    "completion_tokens": 10,
    "total_tokens": 29,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "audio_tokens": 0
    },
    "completion_tokens_details": {
      "reasoning_tokens": 0,
      "audio_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    }
  }
}

OpenAI Chat Completions公式ドキュメント上流プロトコルの定義と最新のフィールド変更を確認します。

認証

リクエストボディ

レスポンスボディ

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`