https://api.yourouter.ai/v1 に OpenAI 互換エンドポイントを提供するため、多くの既存 OpenAI SDK 連携では Base URL と API キー を差し替えるだけで移行できます。
API キーが必要ですか?YouRouter Dashboard で作成できます。
連携の前提
1. API キーを設定する
以下の例を実行する前に、API キーを環境変数へ保存してください。- macOS/Linux
- Windows
- .env
2. 最初のテストリクエスト
最も早い疎通確認は、Chat Completions への直接 HTTP リクエストです。成功するとchoices[0].message.content に生成テキストが入ります。cURL または任意の標準 HTTP クライアントを利用できます。以下の例は Python、Node.js、Go、Java、PHP、Rust を含みます。
- cURL
- Python requests
- Node.js 18+ fetch
- Go
- Java 11+
- PHP
- Rust
3. 既存の OpenAI SDK から移行する
アプリがすでに OpenAI SDK を使っている場合、リクエストボディはそのままにしてapi_key と base_url だけ を差し替えます。
- Python
- Node.js
Go、Java、PHP、Rust でも同じカスタム Base URL の考え方を使います。利用している OpenAI 互換 SDK が base URL 設定に対応している場合は
https://api.yourouter.ai/v1 を指定し、対応していない場合は上記の HTTP 例で /v1/chat/completions を直接呼び出してください。4. モデルとルーティングを選ぶ
model で呼び出すモデルを指定します。OpenAI GPT、Claude、Gemini、DeepSeek、Grok、Doubao、Kimi など、多くのモデル群を同じ API 形で呼び出せます。画像などマルチモーダル入力は マルチモーダル を参照してください。
サンプルのモデルがアカウントで有効になっていない場合は、YouRouter Dashboard に表示される利用可能なモデル ID に置き換えてください。
vendor を省略するか vendor: auto にすると、モデルに対して最も適切な上流へ振り分けます。
特定の上流の挙動、モデル亜種、アカウント分離、コンプライアンス要件などが明確な場合のみ、vendor で固定してください。
- cURL
- Python SDK
- Node.js SDK
5. レスポンスとエラー処理
OpenAI 互換エンドポイントでは、成功レスポンスは OpenAI 形式に従います。生成テキストは通常choices[0].message.content です。
6. ストリーミング
チャット UI やエージェント用途ではstream: true で逐次チャンクを受け取れます。
次のステップ
API リファレンス
エンドポイント、パラメータ、レスポンス形式を確認します。
モデル
モデル ID の渡し方と API 経由でのモデル切り替えを確認します。
マルチモーダル
画像入力を送り、プロバイダー固有のマルチモーダル API を呼び出します。
ルーティング
自動ルーティングとプロバイダー固定を使い分ける場面を確認します。
Chat Completions
会話、ストリーミング UI、ツール、マルチモーダルフローを構築します。