はじめに
認証
API key で TokenLab API リクエストを安全に保護します
APIキー
モデルの呼び出しと非公開リソースには API キーが必要です。GET /v1/models や GET /v1/models/{model} などの公開エンドポイントはキーなしで利用できます。取得に成功してもキーの有効性は確認できません。クイックスタートに沿ってモデルを呼び出してください。一覧のプレフィックスではなく、保存した完全なキーを使用してください。
OpenAI 互換エンドポイントでは、次のように送信します:
Authorization: Bearer sk-your-api-keyAnthropic 互換の /v1/messages リクエストでは、次も使用できます:
x-api-key: sk-your-api-key管理トークン
管理 API は別の種類のトークンを使用します：
Authorization: Bearer mt-your-management-token管理トークンは /v1/management/* エンドポイントでのみ使用してください。選択中のワークスペースの API → Tokens を開き、トークンを作成または置き換えます。完全なトークンは作成または置き換え後に一度だけ表示されるため、その場で安全に保存してください。
管理トークンはモデル推論には使えません。また、通常の sk-... API キーは管理 API には使えません。
API Key の取得
- TokenLab Dashboard にログインします
- API Keys を開きます
- 新しい key を作成します
- わかりやすい名前を付けます
- 表示されるのは一度だけなので、すぐにコピーします
- API key をクライアントサイドのコードに決して公開しないでください
- API key をバージョン管理に決してコミットしないでください
- 環境変数または secret manager を使用してください
- 定期的に key をローテーションしてください
- 使用していない key は削除してください
API Key の使用
環境変数と最初のリクエストはクイックスタートを参照してください。API 形式に合う SDK を使い、キーはサーバー側で管理します。
API Key の機能
使用制限
各 API key に使用制限を設定できます:
| 設定 | 説明 |
|---|---|
| No Limit | 制限なしで アカウント balance を使用して key が動作します |
| Fixed Limit | 指定した金額に達すると key は動作を停止します |
キープレフィックス
すべての TokenLab API key は sk- で始まります。
エラーレスポンス
| ステータスコード | 型 | コード | 説明 |
|---|---|---|---|
| 401 | invalid_api_key | invalid_api_key | API キーがない、無効、停止中、または失効している |
| 401 | expired_api_key | expired_api_key | API キーの有効期限が切れている |
| 402 | insufficient_balance | insufficient_balance | アカウント balance が不足しています |
| 402 | quota_exceeded | quota_exceeded | API key の使用制限に達しました |
例:
{
"error": {
"message": "Invalid API key provided",
"type": "invalid_api_key",
"code": "invalid_api_key"
}
}