アカウント
Kitsch Labsアカウントは、サービスへのログインとAPI利用権限の基準です。 アカウントを作成した後、APIアクセスとキーの発行が必要な場合は サポートチームへお問い合わせください。
アカウントはどこで作成できますか？
組織で利用するアカウントには、個人メールではなく管理可能な業務用アドレスを 使用し、担当者が変わった場合にアクセスを取り消す手順を用意してください。
APIアクセス権はどのように取得しますか？
現在、公開ドキュメントではself-serviceのAPIキー管理画面を案内していません。 APIアクセスと発行手順について確認するには、次の情報を giopaik@kitschlabs.comへお送りください。
- 会社名またはチーム名
- プロダクトとAPIの利用目的
- 想定する月間生成量と最大同時リクエスト数
- 利用する言語と音声
- development用とproduction用のキーを分ける必要があるか
Enterprise契約や利用制限のある音声には、個別の利用範囲と上限が適用される 場合があります。
APIキーはどのような形式ですか？
新しいAPIキーはsk-kitsch-prefixを使用します。
sk-kitsch-<random-secret>
キー全体を確認できるのは発行時の1回だけです。すぐにシークレット管理サービスへ
保存してください。その後はsk-kitsch-abcd...wxyzのようなpreviewのみが
表示されます。
アプリケーションにはどのように設定しますか？
環境変数に保存し、サーバーから読み込みます。
- macOS / Linux
- PowerShell
export KITSCH_API_KEY="<API_KEY>"
$env:KITSCH_API_KEY = "<API_KEY>"
.envファイルを使用する場合は、リポジトリにcommitされないよう
.gitignoreに追加してください。
キーが漏えいした場合は？
- 漏えいしたキーの使用を直ちに停止します。
- サポートチームへrevokeを依頼します。
- 新しいキーを発行し、サーバーのsecretを置き換えます。
- ログとデプロイ履歴から漏えい範囲と不審な利用を確認します。
Revokeは今後のリクエストを遮断しますが、既存の利用記録は削除しません。
認証エラーはどのように確認しますか？
401レスポンスを受け取った場合は、次の順に確認してください。
- ヘッダー名が
xi-api-keyであることを確認 - 値の前後にある引用符、空白、改行を削除
- development用とproduction用のキーが入れ替わっていないことを確認
- キーがrevoke、期限切れ、suspendになっていないことを確認
- 解決しない場合は、レスポンスの
x-kitsch-request-idと発生時刻をサポートへ連絡