APIキーの作成
- ダッシュボードの 設定 > APIキー を開く
- 「APIキーを作成」ボタンをクリック
- キーの名前を入力する(例: CI/CDパイプライン)
- 必要なスコープを選択する
- 「APIキーを作成」をクリック
ws_sk_...)をコピーしてください。**キーは作成時に一度だけ表示されます。**再表示はできないため、安全な場所に保管してください。
スコープ
APIキーには、アクセスできるリソースと操作を制限するスコープを設定します。write スコープには read 権限が含まれます。
| リソース | スコープ | 説明 |
|---|---|---|
| エージェント | agents:read / agents:write | エージェントの取得・作成・更新 |
| セッション | sessions:read / sessions:write | セッションの取得・作成 |
| ピープル | people:read / people:write | ピープルの取得・作成・更新 |
| ナレッジ | knowledges:read / knowledges:write | ナレッジの取得・作成・更新 |
| ポータル | portals:read / portals:write | ポータルの取得・作成・更新 |
| インテグレーション | integrations:read / integrations:write | インテグレーションの取得・設定 |
| メトリクス | metrics:read | メトリクスの取得(読み取り専用) |
APIキーの使用
リクエストのAuthorization ヘッダーに Bearer トークンとしてキーを指定します。
APIキーの無効化
不要になったキーや漏洩の可能性があるキーは速やかに無効化してください。- ダッシュボードの 設定 > APIキー を開く
- 対象のキーの行にあるメニューから「無効化」を選択する
- 確認ダイアログで操作を承認する
注意事項
- APIキーの管理はワークスペース管理者のみ利用できます。
- キーは作成時に一度だけ表示されます。紛失した場合は新しいキーを作成してください。
- キーには有効期限を設定できます。期限切れのキーは自動的に無効になります。
- 無効化したキーを再有効化することはできません。

