API キー
このページの内容
API キーを使うと、独自のソフトウェアや、BYOK（Bring Your Own Key）に対応したサードパーティのシステムで、Performance Hub が公開しているモデルを利用できます。キーは Settings（歯車）→ Service Access & API Keys で管理します。キーを管理するには、組織管理者である必要があります。
"BYOK（Bring Your Own Key）をサポートするサードパーティ製ソフトウェアやシステムがPerformance Hubによって公開されたモデルに接続できるよう、APIキーをプロビジョニングします。"
図 1：API キーの一覧：ラベル、マスクされたキー、ステータス、支出と上限、モデル、最終使用日時、行のアクション
キーの一覧
| 列 | 意味 |
|---|---|
| Label | キーに付けた任意の名前です。 |
| Key | マスクされたキー（例：phk_7Qm2…Xa9LkP）です。完全なシークレットは、作成後に再び表示されることはありません。 |
| Status | Active、Provisioning…（新しいキーの設定中に短時間表示）、または Disabled（取り消し済み。行が淡色表示されます）です。 |
| Spend / limits | 累計の支出と、キーに設定された支出の上限に対する進捗です。 |
| Models | all、またはキーで使用できるように制限されたモデルの数です。 |
| Last used | キーが最後にリクエストを行った日時です。 |
| Actions | Edit、Rotate、Revoke（または Re-activate）、Delete です。 |
Workflows を使用している場合は、Workflows の行に、マスクされたキーの代わりに Managed service と表示されます。キーが 1 つもない場合、一覧には "No API keys yet." と表示されます。
キーの作成
Create key をクリックします。Create API key ドロワーが開きます。
図 2：Create API key ドロワー：ラベル、接続の種類、支出の上限、レート制限、モデルの制限、ガードレールの上書き
| 設定 | 動作 |
|---|---|
| Label (optional) | キーの名前です。通常は、キーを使用するシステムの名前にします（例：Hotel Concierge App、Clinic Intake Assistant、Booking Website）。Activity と Logs では使用状況がラベルで識別されるため、設定を強くおすすめします。 |
| Connection type | API key："Generic API keys remain in the API Keys list." External agent："External agents appear under Connected Services and use this key to authenticate." キーの作成時に設定し、後から変更することはできません。 |
| Set spend limits for this key | "Set any combination of daily, monthly and lifetime caps for this key." Daily limit（"Resets at the start of each day (facility timezone)."）、Monthly limit（"Resets on the 1st of each month (facility timezone)."）、Lifetime cap（"Total spend over the lifetime of this key. Never resets."）があります。 |
| Rate limits (optional) | "Cap requests and tokens per minute for this key. Leave blank for unlimited." Requests / min と Tokens / min があります。 |
| Restrict models for this key | "Only the selected models will be usable with this key." 施設で有効になっているモデルから選択します。 |
| Override facility guardrails for this key | "Select none to explicitly disable guardrails for this key." オンにすると、このキーには施設のガードレールではなく、キー独自のガードレールの選択（「none」を含む）が使用されます。詳しくは、Guardrails を参照してください。 |
Create key をクリックします。
一度だけのシークレット表示
新しいキーは、Copy your API key ダイアログに一度だけ表示されます。
図 3：新しいキーは一度だけ表示されます。ダイアログを閉じる前にコピーしてください
"完全なキーが表示されるのはこの時のみです。安全な場所に保管してください。"
Done をクリックする前に、キーをシークレットマネージャーにコピーしてください。このダイアログを閉じた後は、マスクされた形式でのみ表示されます。シークレットを紛失した場合は、キーを Rotate して新しいキーを取得してください。
キーの編集
キーの行（またはその Edit の鉛筆アイコン）をクリックすると、Configure API key ドロワーが開きます。作成時と同じ設定（ラベル、支出の上限、レート制限、モデルの制限、ガードレールの上書き）を変更できます。
図 4：Configure API key ドロワー
変更は保存後すぐに有効になります。キーに日次/月次の上限が設定されている場合、その行には上限に対する使用状況（Today、This month、Lifetime）が表示され、上限に達すると Limit reached バッジが表示されます。
キーのライフサイクル：ローテーション、取り消し、削除
各アクションには、実行される内容を正確に示す確認ダイアログが表示されます。
| アクション | 効果 | 確認メッセージ |
|---|---|---|
| Rotate | 同じ設定で新しいシークレットを発行します（一度だけ表示）。古いシークレットはすぐに使用できなくなります。 | "A new key will be issued and the current key will stop working immediately." "You will need to reconfigure any services still using the old key. This cannot be undone." |
| Revoke | キーをすぐに無効にします。元に戻すことができます。 | "This key will be disabled immediately and any services using it will stop working. You can re-activate it again later." |
| Re-activate | 取り消したキーを復元します（同じシークレット）。 | なし（すぐに実行されます）。 |
| Delete | キーを完全に削除します。 | "This permanently deletes the key and any services using it will stop working. This cannot be undone." |
図 5：Delete API key の確認
使い分け： 漏洩が疑われる場合はローテーションします（サービスの設定と履歴はそのままで、シークレットを更新するだけです）。システムを一時的に停止する場合は取り消します。連携を完全に廃止する場合にのみ削除します。
キーを使った接続
キーの一覧の下にある Connecting to the API カードには、ベース URL と、環境に合わせてコピーして貼り付けられるリクエストの例が表示されます。SDK の例やエラー処理を含む完全なクイックスタートについては、アプリケーションの接続 を参照してください。