メインコンテンツへスキップ
このガイドでは、アプリを YouRouter に接続し、テストリクエストを送ってレスポンス形式を確認するまでの流れを説明します。YouRouter は https://api.yourouter.ai/v1 に OpenAI 互換エンドポイントを提供するため、多くの既存 OpenAI SDK 連携では Base URL と API キー を差し替えるだけで移行できます。
API キーが必要ですか?YouRouter Dashboard で作成できます。

連携の前提

項目
Base URLhttps://api.yourouter.ai/v1
認証ヘッダーAuthorization: Bearer <YOUR_YOUROUTER_API_KEY>
Content-TypeContent-Type: application/json
モデル指定リクエストボディの model にモデル ID を指定
マルチモーダルmessages[].content にテキストと画像ブロックを並べる
デフォルトルーティングvendor を省略するか vendor: auto
プロバイダー固定vendor: openai / anthropic / google など

1. API キーを設定する

以下の例を実行する前に、API キーを環境変数へ保存してください。
export YOUROUTER_API_KEY="your-api-key-here"
API キーをブラウザ拡張、モバイルアプリ、公開リポジトリ、クライアントログに埋め込まないでください。

2. 最初のテストリクエスト

最も早い疎通確認は、Chat Completions への直接 HTTP リクエストです。成功すると choices[0].message.content に生成テキストが入ります。
curl https://api.yourouter.ai/v1/chat/completions \
  -H "Authorization: Bearer $YOUROUTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {
        "role": "user",
        "content": "Reply with exactly: connected"
      }
    ]
  }'

3. 既存の OpenAI SDK から移行する

アプリがすでに OpenAI SDK を使っている場合、リクエストボディはそのままにして api_keybase_url だけ を差し替えます。
pip install openai
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["YOUROUTER_API_KEY"],
    base_url="https://api.yourouter.ai/v1",
)

completion = client.chat.completions.create(
    model="gpt-4o",
    messages=[
        {
            "role": "user",
            "content": "Reply with exactly: connected",
        }
    ],
)

print(completion.choices[0].message.content)

4. モデルとルーティングを選ぶ

model で呼び出すモデルを指定します。OpenAI GPT、Claude、Gemini、DeepSeek、Grok、Doubao、Kimi など、多くのモデル群を同じ API 形で呼び出せます。画像などマルチモーダル入力は マルチモーダル を参照してください。 デフォルトでは YouRouter が自動ルーティングします。vendor を省略するか vendor: auto にすると、モデルに対して最も適切な上流へ振り分けます。 特定の上流の挙動、モデル亜種、アカウント分離、コンプライアンス要件などが明確な場合のみ、vendor で固定してください。
curl https://api.yourouter.ai/v1/chat/completions \
  -H "Authorization: Bearer $YOUROUTER_API_KEY" \
  -H "Content-Type: application/json" \
  -H "vendor: openai" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "Hello from a pinned provider."}]
  }'
詳細は モデルルーティング を参照してください。

5. レスポンスとエラー処理

OpenAI 互換エンドポイントでは、成功レスポンスは OpenAI 形式に従います。生成テキストは通常 choices[0].message.content です。
{
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "connected"
      }
    }
  ]
}
よくある HTTP ステータス:
ステータス意味対応
200成功ボディをパースする
401API キー不正/未設定Authorization を確認
429レート制限バックオフして再試行、ルーティング見直し
500ゲートウェイ/上流エラー安全に再試行し、リクエスト ID を残す

6. ストリーミング

チャット UI やエージェント用途では stream: true で逐次チャンクを受け取れます。
stream = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Explain automatic routing in two sentences."}],
    stream=True,
)

for chunk in stream:
    delta = chunk.choices[0].delta.content
    if delta:
        print(delta, end="")
詳細なリクエスト形は Create Chat Completion を参照してください。

次のステップ

モデル

モデル ID と vendor の使い方を確認します。

API リファレンス

エンドポイントとパラメータを確認します。

マルチモーダル

画像入力とプロバイダー固有フォーマットを確認します。

ルーティング

自動ルーティングと固定の使い分けを確認します。