本記事では、プロジェクト単位で共通のAPIキーを発行する方法について説明します。
プロジェクト単位のAPIキーを利用すると、1つのAPIキーでプロジェクト内のすべてのエージェントを呼び出せるため、外部アプリ側でエージェントごとにAPIキーを管理する必要がなくなります。複数のエージェントを1つのプロジェクトで運用している場合や、外部アプリとの連携でAPIキーの管理を簡素化したい場合に便利です。
なお、従来のエージェント単位のAPIキーも引き続きご利用いただけます。
この記事を読むと、次のことができるようになります。
- プロジェクト単位のAPIキーを新規発行する
- 発行済みのプロジェクトAPIキーを確認・コピー・再発行する
1. こんな方におすすめです
- 1つのプロジェクト内で複数のエージェントを運用している方
- 外部アプリとの連携時に、APIキーの管理を簡素化したい方
- エージェントを追加・変更した際に、APIキーの再設定の手間を減らしたい方
2. プロジェクト単位のAPIキーとは
プロジェクト単位のAPIキーは、プロジェクト内のすべてのエージェントを呼び出せるAPIキーです。
従来のエージェント単位のAPIキーは、エージェントごとに個別のAPIキーを発行・管理する必要がありました。プロジェクト単位のAPIキーを利用すると、エージェントを追加した場合でも同じAPIキーでそのまま呼び出せるため、外部アプリ側でのキーの追加・変更が不要になります。
種類 | 呼び出せる範囲 | 主な用途 |
|---|---|---|
| プロジェクト単位のAPIキー | プロジェクト内のすべてのエージェント | 複数エージェントをまとめて管理したい場合 |
| エージェント単位のAPIキー | 対象のエージェントのみ | 個別のエージェントごとに管理したい場合 |
3. APIキーを発行する手順
プロジェクト一覧を開きます。
対象プロジェクトの右側にある「︙」ボタンをクリックします。
「APIキー」をクリックすると、APIキーがまだ発行されていない場合は、API発行のダイアログが表示されます。
「APIキーを発行」をクリックすると、APIキーが発行されます。
：表示されたAPIキーをマスキングできます。
：APIキーをクリップボードにコピーできます。
すでにAPIキーが発行されている場合は、発行済みのAPIキーが表示されます。
：マスキングされたAPIキーを表示できます。
- 「APIキーを再発行」ボタンをクリックすると、プロジェクト単位のAPIキーを再発行できます。
4. 補足
- 従来のエージェント単位のAPIキーも引き続きご利用いただけます。プロジェクト単位のAPIキーと併用することも可能です。
- APIキーは機密情報です。第三者に共有せず、安全に管理してください。
- APIキーを再発行すると、以前のAPIキーは利用できなくなります。外部アプリで旧APIキーを設定している場合は、再発行後のAPIキーへ更新してください。