> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arouter.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# BYOK：自分のキーを持ち込む

> お使いの LLM プロバイダー API キーを ARouter で利用し、レート制限・コスト・プロバイダーアクセスを直接管理できます。

## 概要

ARouter はプラットフォームクレジットと、プロバイダーキーの持ち込み（BYOK）の両方に対応しています。自分のキーを使用すると、リクエストはお使いのプロバイダーアカウント経由でルーティングされ、統一 API・フェイルオーバー・分析・支出管理など ARouter のすべての機能がそのまま利用できます。

プロバイダーキーは安全に暗号化され、ルーティング時に自動的に優先使用されます。コードの変更は不要です。ダッシュボードでキーを追加するだけで、既存の ARouter API Key がそのまま機能します。

## 仕組み

```
アプリ → ARouter API（ARouter キー）→ プロバイダー（BYOK キー）
```

1. **設定 → 連携** でプロバイダーの API キーを追加します。
2. ARouter が自動的にそのプロバイダーへのリクエストにあなたのキーを使用します。
3. キーが利用できない場合、ARouter はプラットフォームキーにフォールバックできます（設定可能）。
4. 使用量は BYOK とプラットフォームで別々に記録されます。

## 対応プロバイダー

ARouter は以下の認証方式で BYOK に対応しています：

| 認証方式          | プロバイダー                                   | 必須項目                      |
| ------------- | ---------------------------------------- | ------------------------- |
| **API Key**   | OpenAI、Anthropic、DeepSeek、xAI、Mistral など | API Key                   |
| **Azure**     | Azure OpenAI                             | API Key、エンドポイント URL、デプロイ名 |
| **Bedrock**   | AWS Bedrock                              | アクセスキー、シークレットキー、リージョン     |
| **Vertex AI** | Google Vertex AI                         | サービスアカウント JSON、リージョン      |

## BYOK キーの追加

### ダッシュボード

1. **設定 → 連携** に移動します。
2. **プロバイダーキーを追加** をクリックします。
3. プロバイダーと認証方式を選択します。
4. キーまたは認証情報を入力します。
   5.（任意）**キーをテスト** をクリックして動作を確認します。
5. **保存** をクリックします。

### 詳細オプション

キー追加時に以下の設定が可能です：

| オプション         | 説明                          | デフォルト         |
| ------------- | --------------------------- | ------------- |
| **ラベル**       | キーの名前（例：「本番環境」）             | —             |
| **常にこのキーを使用** | プラットフォームキーへのフォールバックを無効化     | オフ（フォールバック許可） |
| **ウェイト**      | 同一プロバイダーに複数キーがある場合のルーティング重み | 1             |
| **RPM 制限**    | このキーの 1 分あたり最大リクエスト数        | 無制限           |
| **Base URL**  | カスタムエンドポイント URL             | プロバイダーのデフォルト  |
| **リージョン**     | ルーティングの優先リージョン              | 任意            |
| **対応モデル**     | このキーを特定のモデルに限定              | 全モデル          |
| **日次/月次予算**   | USD での支出上限                  | 無制限           |

## フォールバック動作

デフォルトでは、BYOK キーがレート制限やエラーに遭遇した場合、ARouter はシームレスにプラットフォームキーへフォールバックします。この動作はキーごとに変更できます：

| フォールバックポリシー   | 動作                                |
| ------------- | --------------------------------- |
| **許可**（デフォルト） | BYOK が利用できない場合、プラットフォームキーにフォールバック |
| **拒否**        | BYOK キーが利用できない場合、リクエストを拒否         |

ダッシュボードで **「常にこのキーを使用」** を有効にすると、フォールバック拒否に設定されます。

## 複数キー

同一プロバイダーに複数の BYOK キーを追加できます。ARouter は利用可能なすべてのキーから重み付きランダム選択を行います。**ウェイト** フィールドでトラフィック配分を調整してください。

## BYOK 使用量トラッキング

BYOK リクエストは使用量ダッシュボードで個別に追跡されます：

* **BYOK リクエスト数** — 自分のキーを使用したリクエスト件数
* **BYOK 推定コスト** — プロバイダー料金に基づく推定費用
* **プラットフォーム支出** — プラットフォームキーを使用したリクエストの費用

モデル別使用量テーブルには **ソース** 列が表示され、各モデルのリクエストが BYOK、プラットフォーム、またはその両方のいずれかを示します。

## Azure の設定

Azure OpenAI の場合、キー設定を JSON 形式で入力してください：

```json theme={null}
{
  "api_key": "your-azure-api-key",
  "endpoint_url": "https://your-resource.openai.azure.com/openai/deployments/your-deployment/chat/completions?api-version=2024-08-01-preview",
  "deployment_name": "your-deployment-name"
}
```

## AWS Bedrock の設定

AWS Bedrock の場合、AWS 認証情報を入力してください：

```json theme={null}
{
  "access_key": "AKIAIOSFODNN7EXAMPLE",
  "secret_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
  "region": "us-east-1"
}
```

## Google Vertex AI の設定

Vertex AI の場合、サービスアカウントの認証情報を入力してください：

```json theme={null}
{
  "service_account_json": "{...your service account JSON...}",
  "region": "us-central1"
}
```

## BYOK のトラブルシューティング

BYOK リクエストが失敗する場合：

1. **設定 → 連携** でキーのヘルスステータスを確認します。
2. キーをクリックして最新のエラーメッセージを確認します。
3. **キーをテスト** ボタンでキーがまだ有効か確認します。
4. **使用量** ページで BYOK 固有のエラー率を確認します。

よくある問題：

| 症状                  | 原因                 | 対処法                   |
| ------------------- | ------------------ | --------------------- |
| `invalid x-api-key` | キーが期限切れまたは無効化されている | プロバイダーで新しいキーを発行       |
| キーが異常と表示される         | エラー多発によりクールダウンが発動  | クールダウン終了を待つか、編集して再有効化 |
| リクエストが BYOK を使用しない  | プロバイダーまたはモデルの不一致   | キーの対応モデルとリージョン設定を確認   |
| プラットフォームにフォールバック    | BYOK キーがレート制限に到達   | RPM 制限を引き上げるかキーを追加    |