個人用APIキーでできること

APIキーを利用することで、以下のような運用が可能になります。

自動化ツールからの操作：GitHub Actionsなどの外部ツールからRimo VoiceのCLIを呼び出し、録音データのアップロードや文字起こし結果の取得を自動で行えます。
ヘッドレス環境での認証：ブラウザを開くことができないサーバー環境やコンテナ環境でも、環境変数を設定するだけで認証を完了させることができます。
セキュアな権限管理：特定の用途ごとに名前を付けてキーを発行できるため、どの自動化処理でどのキーを使っているかの管理や、不要になった際の個別の無効化が容易です。

事前準備：CLI APIキー管理（管理者のみ）

組織の管理者は、以下の操作が可能です。

1. グローバルメニュー「設定」から「CLI API キー管理」を開きます。

2. 「メンバーによるCLI APIキーの作成を許可する」 をオンにしてください。

「利用状況」エリアに組織全体の合計（合計・有効・無効・キーを持つユーザー数）が表示されます。
「組織内のすべてのAPIキー」エリアでは、各キーの名前・所有者・ステータス・作成日・有効期限・最終利用を表示されます。また、所有者・ステータスなどで検索・絞り込みが可能です。

退職者のキーなどを停止する場合、対象となるAPIキーの右側に表示されている「・・・」からメニューを開いて「無効化」を選びます。メンバー自身による無効化と同様に、即時に反映され、取り消しはできません。

1. グローバルメニュー「設定」から「API キー」を開き、画面右上の「キーを作成」ボタンをクリックします。

2. 以下の項目を入力・選択し、「作成する」ボタンをクリック。

3. APIキー（ rimo_pat_ で始まる文字列）が表示されます。

表示は一度だけです：作成直後に表示されるキーは、その時しか確認できません。必ずコピーして、パスワードマネージャーや自動化ツールのシークレットストアなど安全な場所に保存してください。
キーを紛失した場合は復元できません：古いキーを無効化し、新たにキーを作成してください。
他人に教えない：APIキーはパスワードと同じです。メールやチャットで送ったり、公開される場所に書き込んだりしないでください。

コピーしたキーを環境変数 RIMO_API_KEY に設定することで、CLIからの操作が認証されます。

ターミナルを開いて、以下のコマンドを入力します。

export RIMO_API_KEY="rimo_pat_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

rimo note list        # すぐに動作します。`rimo auth login` は不要です

PowerShellを開いて、以下のコマンドを入力します。

$env:RIMO_API_KEY = "rimo_pat_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

rimo note list        # すぐに動作します。`rimo auth login` は不要です

CI/CD（GitHub Actions、GitLab CI など）では、キーを直接書き込まず、暗号化された シークレット として RIMO_API_KEY を登録します。

GitHub Actionsの例：

- run: rimo note search "Q3 release plan"
  env:
    RIMO_API_KEY: ${{ secrets.RIMO_API_KEY }}

「APIキー」ページには、作成したすべてのキーが一覧表示されます。各キーで次を確認できます。

名前
ステータス
- 有効：利用可能な状態
- 残りN日：有効だが、まもなく期限切れ（14 日以内）
- 期限切れ：有効期限を過ぎており、利用不可
- 無効化済み：手動で無効化されており、利用不可
作成日
有効期限
最終使用（キーが最後にリクエストを認証した日時。未使用の場合は「―」表示）