メインコンテンツへ移動
AIチュートリアル

RouterHub APIチュートリアル:モデルの確認、APIキーの取得、OpenRouterからの移行

このチュートリアルでは、RouterHubのドキュメントハブを通じて、モデルカタログの閲覧、APIキーの取得、料金とモデルバリエーションの確認、実装の詳細を把握するためのAPIクイックスタートまたは移行ガイドの利用方法を紹介します。

RouterHub APIチュートリアル:モデルの確認、APIキーの取得、OpenRouterからの移行

RouterHubが提供するもの

RouterHubはOpenRouterの代替サービスとして紹介されており、リアルタイムのモデルカタログとAPIアクセスのワークフローを提供します。このリポジトリは、モデルの検索、APIの利用、移行、料金、バリアント、ユースケース、安全性、トラブルシューティングを扱うドキュメントハブです。

ドキュメントは、目的ごとに整理された一連のガイドで構成されています。最初から順に読むことも、作業に合ったトピックへ直接移動することもできます。

適切な開始地点を選ぶ

アクセスを設定する

  1. RouterHub登録ページを開き、オンボーディングの手順に従ってAPIキーを取得します。
  2. モデルカタログのドキュメントを確認し、アプリケーションに必要な正確なモデルIDと対応プロトコルを特定します。
  3. 既存のOpenRouter連携を移行する場合は、記載されているベースURL、キーの取り扱い、モデルマッピングについて移行ガイドを参照してください。
  4. APIクイックスタートを使って、最初のリクエストを作成し送信します。

APIキーは非公開にしてください。ソースコードに直接記述するのではなく、環境変数や別のシークレット管理システムに保存してください。

正しいモデルを見つける

モデルの選択はRouterHubのワークフローにおける重要な要素です。このリポジトリには、モデルファミリー、モデルID、プロトコルを扱うカタログガイドが用意されています。識別子を推測せず、このガイドとリアルタイムのモデルカタログを併用してください。

実際の選択手順は次のようになります:

  1. コーディング、エージェントワークフロー、リサーチ、執筆など、タスクを定義します。
  2. 利用可能なモデルファミリーとバリアントの情報を確認します。
  3. カタログに表示されている正確なモデルIDをコピーします。
  4. モデルのプロトコルが、使用予定のクライアントまたは連携に対応していることを確認します。
  5. 本番トラフィックを送信する前に料金ドキュメントを確認します。

最初のAPIリクエストを送信する

このリポジトリでは、最初のリクエストにAPIクイックスタートを利用するよう案内しています。正確なエンドポイントとリクエスト形式はそのガイドで管理されているため、別の例にあるエンドポイントをそのまま使用せず、ガイドの最新の値を使ってください。

リクエストの設定には、通常、次の記載値が必要です:

APIキー: <あなたのRouterHub APIキー>
ベースURL: <RouterHub APIクイックスタートの値>
モデルID: <モデルカタログの正確なID>
プロトコル: <選択したモデルが対応するプロトコル>

具体的な実装については、APIクイックスタートを開いてリクエスト例をコピーし、APIキーを安全に設定したうえで、モデルの値をカタログから選択した正確なIDに置き換えてください。

既存のOpenRouter連携を移行する

アプリケーションですでにOpenRouterを使用している場合は、リポジトリの移行ガイドに従ってください。READMEでは、ベースURLの変更、RouterHub APIキーの使用、モデル識別子のマッピングという3つの移行上の注意点を挙げています。

テスト前に次のチェックリストを確認してください:

  • 移行ドキュメントに従ってプロバイダーのベースURLを更新します。
  • 既存の認証情報をRouterHub APIキーに置き換えます。
  • 各モデル名を確認し、正確なRouterHubモデルIDにマッピングします。
  • 選択したモデルが必要とするプロトコルを確認します。
  • 連携を本番環境へ移行する前に、小規模なテストリクエストを送信します。

切り替えの理由を詳しく知るには、プリペイド請求、モデルID、無検閲オプションを扱う切り替える理由をお読みください。

料金とバリアントを確認する

料金

料金ガイドでは、トークン単位の例を説明しています。これを使って、想定するワークロードのコストを見積もり、リクエストを増やす前にモデルを比較してください。

無検閲モデルとアブリテレーテッドモデル

無検閲モデルとアブリテレーテッドモデルのガイドでは、これらのバリアントを比較できます。リポジトリの安全性ガイドも読み、各モデルを合法的かつ責任を持って使用してください。

実用的なユースケースを確認する

最初のリクエストが正常に動作したら、ユースケースガイドでコーディング、エージェント、リサーチ、執筆について確認できます。これらの例を使って、構築するアプリケーションの種類に合ったモデルファミリーとプロトコルを選んでください。

運用に関する質問については、トラブルシューティングガイドを参照してください。認証、モデルID、プロトコルについて具体的に説明しています。FAQではより詳しい回答を提供し、用語集ではドキュメント全体で使用される用語を解説しています。

高度なヒント

  • 正確なIDを使用する: 名前の違いによる失敗を避けるため、カタログからモデル識別子をコピーしてください。
  • 早めにプロトコルを確認する: アプリケーションコードのデバッグを行う前に、プロトコルの互換性を検証してください。
  • 設定とコードを分離する: APIキー、ベースURL、モデルIDを設定可能にして、移行やテストを容易にしてください。
  • まずコストを見積もる: 大規模な処理を実行する前に、トークン単価の例を使用してください。
  • ドキュメントのパスを活用する: すべての統合問題を一般的なAPIの問題として扱うのではなく、移行、クイックスタート、料金、またはトラブルシューティングのガイドを選択してください。
  • 安全性を確認する: 検閲なしまたはアブレーション済みのバリアントを評価する際は、安全性に関するガイダンスを読み、合法的な目的に限って使用してください。

まとめ

RouterHubリポジトリは、OpenRouterの代替サービスを評価し、そのAPIと統合するための体系的な出発点です。まずAPIキーを取得し、カタログから正確なモデルIDを選択してプロトコルを確認し、APIクイックスタートに従ってください。既存のアプリケーションを移行する場合は、専用の移行ガイドを使用し、デプロイ前に料金、バリアント、安全性、トラブルシューティングに関する事項を確認してください。