チャット補完を作成

会話履歴に基づいてモデルのレスポンスを作成します。ストリーミングと非ストリーミングのレスポンスに対応しています。 OpenAI Chat Completions API と互換性があります。

POST /v1/chat/completions

サービスルート: https://getrouter.ai

プロトコル: OpenAI Chat Completions

認証: Authorization: Bearer YOUR_API_KEY

リクエストボディ

リクエストボディは必須です。 メディアタイプ: application/json

リクエストフィールド

フィールド必須説明
modelstringはいモデル ID
messagesarray<object>はい会話メッセージ一覧
temperaturenumberいいえサンプリング温度 デフォルト: 1; 範囲: 0–2
top_pnumberいいえ核サンプリングパラメータ デフォルト: 1; 範囲: 0–1
nintegerいいえ生成数 デフォルト: 1; 範囲: 1–∞
streambooleanいいえストリーミングレスポンスを使用するかどうか デフォルト: false
stream_optionsobjectいいえ
stopstring or array<string>いいえ停止シーケンス
max_tokensintegerいいえ生成する Token の最大数
max_completion_tokensintegerいいえ補完 Token の最大数
presence_penaltynumberいいえデフォルト: 0; 範囲: -2–2
frequency_penaltynumberいいえデフォルト: 0; 範囲: -2–2
logit_biasobjectいいえ
userstringいいえ
toolsarray<object>いいえ
tool_choicestring or objectいいえ
response_formatobjectいいえ
seedintegerいいえ
reasoning_effortstringいいえ推論強度(推論対応モデル用) 選択肢: low, medium, high
modalitiesarray<string>いいえ
audioobjectいいえ

リクエスト例

curl --request POST \
  --url https://getrouter.ai/v1/chat/completions \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "model": "MODEL_ID",
  "messages": [
    {
      "role": "system",
      "content": "こんにちは。自己紹介してください。"
    }
  ],
  "stream": false,
  "temperature": 1,
  "max_tokens": 1
}'

レスポンス

ステータス説明
200レスポンスを正常に作成
400リクエストパラメータが不正です
429リクエストのレート制限

成功レスポンスのフィールド

フィールド必須説明
idstringいいえ
objectstringいいえ
createdintegerいいえ
modelstringいいえ
choicesarray<object>いいえ
usageobjectいいえ
system_fingerprintstringいいえ

レスポンス例

{
  "id": "string",
  "object": "object",
  "created": 1,
  "model": "MODEL_ID",
  "choices": [
    {
      "index": 1,
      "message": {
        "role": "system",
        "content": "こんにちは。自己紹介してください。",
        "name": "string",
        "tool_calls": [
          {
            "id": null,
            "type": null,
            "function": null
          }
        ],
        "tool_call_id": "string",
        "reasoning_content": "string"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "total_tokens": 1,
    "prompt_tokens_details": {
      "cached_tokens": 1,
      "text_tokens": 1,
      "audio_tokens": 1,
      "image_tokens": 1
    },
    "completion_tokens_details": {
      "text_tokens": 1,
      "audio_tokens": 1,
      "reasoning_tokens": 1
    }
  },
  "system_fingerprint": "string"
}

関連ガイド

詳しいワークフローと例については、Chat Completions API ガイドを参照してください。


このページは公開 Relay OpenAPI 仕様から自動生成されています。仕様全体は API Explorer で確認できます。