SHOHS AI APIキーを取得する方法
SHOHS AI APIのキーは、Cloud Consoleでプロジェクトを作成し、ライブラリでSHOHS AI APIを有効化したうえで、「認証情報」から「API キーを作成」で発行します。キーは作成直後の1回だけ表示されます。
SHOHS AI APIキーを取得する方法
この記事では、SHOHS AI APIを使うためのAPIキーを、SHOHS Cloud Consoleで発行する手順を説明します。SHOHS AI APIはOAuthではなくAPIキーで認証するAPIで、テキスト生成や音声合成などのAI機能を自分のアプリから利用できます。
手順
- SHOHS Cloud Consoleでプロジェクトを作成(または選択)します。
- 「ライブラリ」からSHOHS AI APIを有効化します。
- 「認証情報」から「API キーを作成」を選びます。
- キー名、使う機能、利用制限を設定して発行します。
- 発行されたAPIキー(shk_ で始まる文字列)を、安全な場所に保存します。
キーごとに設定できること
- 使える機能:テキスト生成、音声合成、Live API、エージェント、Google 検索/マップのグラウンディングなどから選択できます。許可していない機能は利用できません。
- 許可オリジン:ブラウザ(JavaScript)から呼ぶ場合に、呼び出しを許す生成元。空欄の場合はブラウザからの呼び出しは拒否されます。
- 許可IP:呼び出しを許すIPアドレスまたはCIDR。空欄の場合は制限なしです。
- 利用量の上限:1分あたり/1日あたりのリクエスト数の上限。超えるとエラー(429)が返ります。
注意点
- APIキーが表示されるのは、作成直後の1回だけです。必ずその場で保存してください。キーはハッシュとして保存されるため、あとから元の値を確認することはできません。紛失した場合は再発行してください。
- APIキーはブラウザやモバイルアプリのコードに埋め込まないでください。キーを知っている人は誰でも、あなたの上限までAIを使えてしまいます。
- キーが漏れた疑いがあるときは、Cloud Consoleでそのキーを削除して再発行してください。プロジェクトでAI APIを無効化すると、そのプロジェクトのすべてのキーが即座に使えなくなります。
よくある質問
キーが使えるか確認する方法はありますか?
キーを Authorization ヘッダーに付けて https://ai.apis.shohs.net/v1/tokeninfo へリクエストすると、そのキーの機能や上限を確認できます。詳しくは開発者ドキュメントをご覧ください。
用途ごとにキーを分けられますか?
はい。プロジェクト内で複数のキーを発行し、キーごとに機能や制限を変えられます。用途ごとに分けると、漏えい時の影響を小さくできます。