ログイン
API ドキュメント

API Reference

各モデルプロバイダーの公式 API と互換性のある形式でモデルサービスを呼び出します。

30
モデルAPIエンドポイント
8
カテゴリ
API Key
認証方式

API Reference

最初のリクエストが成功した後、またはプロバイダー別の詳細が必要な場合に使います。

30 モデルAPIエンドポイント
POSTOpenAIOpenAI/chat/completions

Create Chat Completion

会話履歴からモデル応答を作成し、ストリーミング、ツール、使用量集計に対応します。

認証方式

ユーザーの API キーを Authorization: Bearer sk-xxxx で指定します。

Authorization: Bearer sk-xxxx
Content-Type
application/json
モデル例
gpt-4o, gpt-4.1, gpt-5, o3, o4-mini

リクエスト例

{
  "model": "gpt-4o",
  "messages": [
    {
      "role": "user",
      "content": "Hello"
    }
  ],
  "stream": false
}

レスポンス例

{
  "id": "chatcmpl_xxx",
  "object": "chat.completion",
  "created": 0,
  "model": "gpt-4o",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello!"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 8,
    "completion_tokens": 3,
    "total_tokens": 11
  }
}

curl 例

curl -X POST 'https://costrouter.ai/v1/chat/completions' \
  -H 'Authorization: Bearer sk-xxxx'
  -H 'Content-Type: application/json'
  -d '{
  "model": "gpt-4o",
  "messages": [
    {
      "role": "user",
      "content": "Hello"
    }
  ],
  "stream": false
}'
パラメータ
名前必須説明
modelstringはいモデル ID。バックエンドがモデル名から利用可能なチャネルを選択して転送します。
messagesarray<object>はい会話メッセージ配列。通常は system、user、assistant、tool ロールを含みます。
temperaturenumberいいえサンプリング温度。高いほど出力はランダムになります。
top_pnumberいいえ nucleus sampling パラメータ。通常は temperature とどちらかを調整します。
streambooleanいいえストリーミング応答を返すかどうか。
max_tokensintegerいいえ最大出力 token 数。
toolsarray<object>いいえツールまたは関数定義。対応状況は上流モデルに依存します。
response_formatobjectいいえ構造化応答形式。対応状況は上流モデルに依存します。
レスポンス例
名前必須説明
idstringいいえ応答、タスク、またはリソース ID。
objectstringいいえ応答オブジェクト種別。
createdintegerいいえ作成タイムスタンプ。
modelstringいいえ-
choicesarray<object>いいえモデル出力候補。
usageobjectいいえtoken 使用量統計。

基本概念

連携をデバッグする前に、新規ユーザーが理解しておきたい項目です。

API-Key: your CostRouter key authenticates requests to every supported model.
Base URL: プロバイダー URL を CostRouter relay URL に置き換えます。
Model name: payload のモデル名を維持し、CostRouter が利用可能なチャネルを選びます。
Usage and billing: リクエスト完了後、Usage Logs と Billing にコストが表示されます。

モデルの選び方

どの endpoint から始めるか迷う場合は、次を目安にしてください。

一般的なチャット: gpt-4o-mini または低コストの chat モデルから開始します。
推論やコード: 基本リクエストが動いた後に、より強いモデルを選びます。
画像、音声、動画: API Reference の対応カテゴリを使います。
価格確認: 本番トラフィック前に Models でグループと料金を比較します。

よくあるエラーと修正

初回の失敗は、認証、モデル名、quota、リクエスト形式が原因になりがです。

401

認証に失敗しました

Check that Authorization uses Bearer plus your CostRouter API-Key.

403

アクセス権または残高不足

キー状態、残高、モデル権限、請求設定を確認してください。

429

レート制限

同時実行数を下げ、バックオフ付きで再試行するか、アカウント制限を確認してください。

5xx

上流またはルーティング失敗

後でもう一度試し、Usage Logs でリクエスト状態とモデルルートを確認してください。

お問い合わせ

お問い合わせ内容に最も近い窓口を選択してください。

お問い合わせ
API ドキュメント - CostRouter