APIキー
API 用のキーを作り、範囲を決め、管理する。
API キーは Reverie のオープン API へのリクエストを認証します。キーは設定 → その他 → APIキーにあり、Labs の オープン API タイルが向かう先もここです。どのアカウントでも作れます——区分の条件もなければ、持てる本数の上限もありません。
キーを作る
「新しいAPIキーを作成」を押す
ページがまだ空のときは、ボタンの文言が最初のAPIキーを作成になっています。
名前をつける
名前は必須で、1〜100 文字です。一覧や利用統計でこのキーがどう表示されるかを決めます——「リビングのスピーカー」「staging worker」のように。
グローバルか特定のキャラクターかを選ぶ
キャラクター選択はグローバル（全キャラクター）と特定のキャラクターの二択で、省略できる追加項目ではありません。特定のキャラクターを選ぶと、それがこのキーに固定されたキャラクターになります。
必要ならデバイスタイプと有効期限も
デバイスタイプは自由入力です（speaker、phone、iot）。有効期限は日付と時刻の両方を取り、その瞬間にキーは自動的に使えなくなります。
キーはすぐに表示され、rk_ に続けて 16 進数 64 文字という形です。
キーはいつでも取り出せます
一度きりの表示ではありません。キーが存在するかぎり、そのカードにはAPI キーを表示、API キーを非表示、API キーをコピーがいつでも並んでいます。
完全な秘密鍵が設定画面からいつでも読めるということは、アカウントへのアクセスはキーへのアクセスと同じだということです。キーはサーバーかシークレットマネージャーに置き、ソース管理やブラウザのコードには決して置かないでください。
グローバルなキーと固定されたキー
| グローバル（全キャラクター） | 特定のキャラクター | |
|---|---|---|
GET /models が返すもの | 直近のキャラクター | そのキャラクターのシナリオ、ひとつもなければキャラクター自身 |
model を省略したとき | 直近のチャットに落ちます | 固定されたキャラクターを使います |
| 短いシナリオ ID | 決して解決しません | 固定されたキャラクターの中で解決します |
無効化、削除、ローテーション
| 操作 | 効果 | 取り消せるか |
|---|---|---|
| アクティブのトグル | オフのあいだ、そのキーを使ったリクエストは拒否されます | はい |
| 削除 | キーは破棄され、それを使っているアプリはアクセスを失います | いいえ |
取り消し専用の操作はありません——無効化と削除の二つだけです。
キーの削除は取り消せません。しかも、そのキーの実績も一緒に持っていきます。過去のトラフィックは利用統計の削除済みのキーのまとまりに移り、どの連携がいくら使ったのかは分からなくなります。履歴が要るかもしれないなら、まずは無効化してください。
ローテーションするときは、代わりのキーを作り、配備してから、古いキーを無効化するか削除します。自動ローテーションはなく、期限切れ後の猶予もありません——期限切れのキーは次のリクエストで api_key_expired として拒否されます。
スコープ
キーにはスコープがありますが、作成ダイアログはそれを見せません。設定画面で作ったキーが呼べるのはチャット関連のエンドポイントだけです。
キャラクター取り込みのエンドポイントには別のスコープが要り、そういうキーを手に入れる方法は Labs → キャラクターインポートスキルを開くことだけです。そこで Reverie Character Importer (Skill) という名前のキーが作られます。設定画面の普通のキーで取り込みを呼ぶと 403 が返ります。キャラクターの取り込み →
利用統計
同じページの利用統計パネルは、リクエスト、トークン、クレジット、アクティブなキーを UTC の日ごとに区切って表示し、キー別の利用状況の下にキーごとの内訳を出します。特定のキーかすべてのキーで絞り込め、期間は 7 日から 90 日まで——既定は 30 日です。集計されるのは API 経由で作られたチャットだけです。
キーごとの支出が分かるのはこのパネルだけです。クレジット履歴には各メッセージの費用が残りますが、その取引がどのキーによるものかは書かれていないので、連携どうしを比べるならここの統計を使ってください。
リクエストを作成
リクエストを作成を押すとジェネレーターが開きます。アクティブなキーを一つ選び、そのキーから見えるキャラクターかシナリオを選び、メッセージを入力し、ストリーミングと temperature を決めれば、そのまま動く cURL、TypeScript、Python をコピーできます。
キーはブラウザ内でキャラクター一覧を読み込むためだけに使われます。生成されるコードは秘密鍵を埋め込まず、環境変数から REVERIE_API_KEY を読みます。
上限
| 上限 | 値 |
|---|---|
| アカウントあたりのキー数 | 制限なし |
| キーごとのレート制限 | なし |
| キーごとの同時実行上限 | なし |
| 実際に使用量を縛るもの | クレジット残高と、無料モデルの枠 |
関連
- オープン API —— エンドポイント、リクエストの形、エラー
- キャラクターの取り込み —— 取り込み用のキーが何のためにあるか
- Reverie Labs —— オープン API と取り込みのタイル
- セキュリティ —— アカウントのそのほかのアクセス設定