Management API Keys

Management API Key はチーム全体のプロジェクト、予算、モデル API キーを管理し、プロジェクトとキーの使用量を取得します。

Management API Key はチーム全体のプロジェクト、予算、モデル API キーを管理し、プロジェクトとキーの使用量を取得します。

エンドポイントとキーの対応

この比較は API キーが対象です。有効化済みの OAuth scoped token による課金照会は従来どおり利用できます。

管理キーを作成

  1. Console にログインし、自分が Owner であるチームアカウントに切り替えます。
  2. サイドバーの Developer → Management API Keys を開くか、管理ページに直接移動します。この項目は現在のチーム Owner にのみ表示されます。
  3. Name を入力し、必要に応じて Expires (optional) を設定して Create key をクリックします。
  4. Copy key をクリックして新しい mgmt-... を保存し、以下の例では ATLASCLOUD_MANAGEMENT_API_KEY に設定します。シークレットは一度だけ表示されます。

api_key_id はどこで取得しますか?

URL の api_key_id は、モデル API キーの作成(POST /public/v1/api-keys)のレスポンスに含まれる id(ak_... 形式)です。 無効化、削除、利用上限の設定、使用量の照会に使うため保存してください。レスポンスの key(apikey-...)はモデル呼び出し用です。管理操作の認証ヘッダーには引き続き mgmt-... を指定します。

作成レスポンスには、例えば次のフィールドが含まれます。

{
  "id": "ak_0123456789ABCDEFGHIJKL",
  "key": "apikey-REPLACE_WITH_SECRET_RETURNED_ONCE"
}

同じ id を /public/v1/api-keys/ak_0123456789ABCDEFGHIJKL/usage のようにパスへ指定します。例の API_KEY_ID もこの値を表します。現在、Public API にキー一覧取得エンドポイントはないため、作成時に id を保存してください。

Public API を呼び出す

管理キーを Authorization: Bearer ヘッダーに指定してください。リクエストは、そのキーに紐付く Team アカウントを使用します。

curl -X POST "https://api.atlascloud.ai/public/v1/projects" \
  -H "Authorization: Bearer $ATLASCLOUD_MANAGEMENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"customer-123"}'

作成手順(英語).

キーを管理

無効化、削除、または期限切れの管理キーでは認証できません。有効期限内のキーは管理ページで有効化・無効化できます。削除は取り消せません。

管理キーはチームに属し、作成者がチームを離れたり Owner でなくなったりしても有効です。現在の Owner は以前の Owner が作成したキーも管理できます。アクセスを取り消すにはキーを無効化または削除してください。

各チームで保持できる管理キーは、無効化済み・期限切れも含めて 未削除のものが最大 5 個です。削除すると空き枠ができます。

Last updated on

On this page