Chat Completions

Chat Completions は最もよく使われる会話 API です。通常のチャット、コーディングアシスタント、要約、分類、ツール呼び出し、複数ターン会話に適しています。

Endpoint

POST /v1/chat/completions

完全な URL：

https://www.routeapi.ai/v1/chat/completions

リクエスト例

curl https://www.routeapi.ai/v1/chat/completions \
  -H "Authorization: Bearer $ROUTEAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      { "role": "user", "content": "RouteAPI を一文で紹介してください" }
    ]
  }'

リクエストパラメータ

フィールド	型	必須	説明
model	string	はい	モデル ID。現在のアカウントで利用可能なモデルである必要があります
messages	array	はい	会話メッセージ一覧
stream	boolean	いいえ	SSE ストリーミング出力を使用するかどうか
temperature	number	いいえ	サンプリング温度
top_p	number	いいえ	nucleus sampling パラメータ
max_tokens	number	いいえ	最大出力 token 数
tools	array	いいえ	ツール定義
tool_choice	string/object	いいえ	ツール選択ポリシー
response_format	object	いいえ	JSON mode または JSON Schema
stream_options	object	いいえ	ストリーミング出力の追加オプション

messages 形式

[
  { "role": "system", "content": "あなたは慎重な技術アシスタントです。" },
  { "role": "user", "content": "API ゲートウェイとは何かを説明してください。" }
]

よく使われる role：

Role	説明
system	システムプロンプト
user	ユーザー入力
assistant	モデルの過去応答
tool	ツール呼び出し結果

レスポンス例

{
  "id": "chatcmpl_xxx",
  "object": "chat.completion",
  "created": 1730000000,
  "model": "gpt-4o",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "RouteAPI は、複数の AI モデルサービスを統一して管理する API ゲートウェイです。"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 24,
    "completion_tokens": 18,
    "total_tokens": 42
  }
}

互換性の注意

• 同じパラメータでも、モデルサービスによって対応状況が異なる場合があります。
• tools、response_format、stream_options などの任意パラメータを含める場合は、選択したモデルが対応しているか事前に確認してください。
• 明示的に渡された 0 または false の任意パラメータは、ユーザーが明示設定した値として扱われるべきです。