認証とAPIキー
APIキーの送信方法と、キーごとに利用範囲を制限する方法。
すべてのリクエストにAPIキーが必要です。キーの作成と管理はコンソールのAPIキーページで行います。
キーの送信方法
| エンドポイント | ヘッダー |
|---|---|
| すべてのエンドポイント | Authorization: Bearer sk-... |
/v1/messages（Anthropic形式） | x-api-key: sk-...も使えます |
公式SDKでは、api_key / apiKeyを渡せば正しいヘッダーが自動で設定されます。
キーはパスワードと同じように扱ってください。環境変数やシークレットマネージャーに保管し、クライアント側のコードや公開リポジトリには絶対に含めないでください。キーが漏洩した場合は、コンソールで削除して新しいキーを作成してください。
キーの制限
コンソールのAPIキーページでAPIキーを作成をクリックするか、既存のキーの横にある編集をクリックすると、そのキーの制限を設定できます。4つの制限にはそれぞれスイッチがあり、オフなら制限なし、オンにすると値を設定できます。変更はすぐに反映されます。
| 制限 | 内容 |
|---|---|
| 有効期限 | 7日、30日、90日、1年のいずれか、または「カスタム」で日付を指定します。その日の現地時間23:59にキーは無効になり、以降のリクエストには401が返されます。 |
| 利用上限 | 米ドル建ての金額です。キーの利用額がこの金額に達するとキーは無効になり、以降のリクエストには401が返されます。キーの編集時はここに残りの利用可能額が表示され、値を変更すると残額がその金額にリセットされます。 |
| 許可するモデル | カタログからモデルを選ぶか、一覧にないモデルIDを入力します（最大50個）。それ以外のモデルを呼び出すと403が返されます。 |
| IP許可リスト | 1行に1つずつIPアドレスまたはCIDR範囲を入力します（最大20個）。それ以外のアドレスからのリクエストには403が返されます。 |
キーを編集しても、有効期限と利用上限は変更しない限りそのまま維持されます。キー一覧では、利用上限列に各キーの残りの利用可能額と利用済みの額が表示され、キーがいずれかの制限に達すると状態に期限切れまたは上限到達と表示されます。利用上限をどのように設定しても、アカウントの残高を超えて利用されることはありません。
アプリごとに1つのキー
アプリケーション、環境、チームメンバーごとに専用のキーを発行してください。キー一覧でキーごとの利用額を確認でき、利用上限で使いすぎを防いだり、ほかに影響を与えずにそのキーだけを削除したりできます。