認証
すべてのリクエストは、 Authorization ヘッダーに API キーを Bearer トークンとして含めて認証します。キーは sk-bk- で始まり、1 つの組織に属します。x-api-key ヘッダーも受け付けますが、リクエストに Authorization ヘッダーがない場合にのみ読み取ります。Bearer 形式でない Authorization ヘッダーは、x-api-key にフォールバックせず 401 で拒否します。
header
Authorization: Bearer sk-bk-...注意
API キーは秘密情報です。キーを入手した人は誰でもクレジットを消費できます。 コミットしたり、フロントエンドコードに埋め込んだり、共有したりしないで ください。環境変数に保存し、漏洩した場合はすぐに失効させてください。
キーの管理
コンソール → API キー でキーの発行・命名・失効を行います。シークレットの全体は発行時に一度だけ表示され、以降はマスクされた値しか表示されません。
- アプリケーションや環境(prod、staging、local)ごとに、キーを分けて発行してください。
- 漏洩の疑いがあれば、すぐにキーを失効させてください。失効は即時に反映されます。
- キーは定期的にローテーションしてください。保持できるキー数に制限はありません。
組織とプロジェクト
各キーは 1 つの組織と 1 つのプロジェクトに紐づきます。使用量とクレジット消費はその組織に帰属するため、課金とレート制限は組織単位で適用されます。コンソールでアクティブな組織を切り替えて、その組織のキーとクレジットを管理してください。 ロール・招待・プロジェクト・キー上限・予算・クレジットは 組織と予算 ページを参照してください。
リクエストが拒否された場合は、 エラー で 401/403 ステータスコードとその意味を確認してください。