最初の準備(保管庫と API キー)
準備は、最初の 1 回だけです。
1. 認証をクラウド金庫に保管する
デスクトップの Fuga で、設定を開きます。
「☁ クラウドへ保管」欄の「このPCのログインをクラウドへ保管」を押します。
確認の文を読んで「同意してオンにする」を押すと、保管が始まります(設定の後半)。
保管できたエンジンの名前が、欄の横に「✓」と並びます。
API で使えるのは、ここで保管したエンジンだけです。
認証の保管は、デスクトップの Fuga からしかできません。API からは保管できません。
2. API キーを作る
会員ページの「API keys」を開き、キーを作ります。
作成の画面で、キーの名前と、下の 2 つの許可を選びます。
キーの値(kamui_sk_…)は、作ったときに 1 回だけ表示されます。その場で控えてください。
会員ページで作ったキーの有効期限は 90 日です。
キーの許可(作るときに決める)
| 許可 | 作成の画面の表示 | 既定 | オンにすると |
|---|---|---|---|
| クラウド実行の起動 | 「このキーで実行API(/launch・/orchestrate)を使えるようにする」 | オフ | /launch と /orchestrate を呼べる。オフのキーで呼ぶと 403 になる。オフでも /result や /quota などの読み取りは使える。 |
| 成果テキスト | 「成果テキスト(エージェントの最終回答)の取得を許可」 | オフ | /result の resultText を読める。オフでも、Git のブランチは取得できる。 |
| エンジンの限定 | (今の作成の画面にはありません) | 限定なし | 限定したキーは、列挙したエンジンだけ起動できる。それ以外のエンジンは 403 になる。 |
許可は、作ったあとで変えられません。変える API もありません。
許可が足りないときは、キーを作り直してください。
テキストだけを受け取る使い方(1 人で実行する)では、「クラウド実行の起動」と「成果テキスト」の両方をオンにします。
API キーでできないこと
- クラウド金庫に認証を保管する、または消す。
- 保管した認証を見る、書き出す。
- API キーを作る、消すなどの、キーの管理。
キーが漏れても、認証そのものを持ち出されたり、別のキーを作られたりはしません。
ただし、「クラウド実行の起動」をオンにしたキーなら、あなたの認証で実行を回せます。実際に実行を回す用途のキーだけ、オンにしてください。