APIキー

概要

APIキーを使用すると、外部のアプリケーション、スクリプト、サービスからGiselle APIにプログラムでアクセスし、アプリを実行できます。APIキーはチーム単位でスコープされており、チームメンバー全員が同じAPIキーセットを共有します。

APIキーの作成

APIキーの形式

APIキーは以下の形式に従います：

gsk_<id>.<secret>

例：gsk_abc123xyz.secret_value_here

設定でAPIキーを表示する際は、最初と最後の数文字のみが表示される短縮版（例：gsk_abc...xyz）が表示されます。

APIキーの管理

APIキーの表示

APIキーページには、チームのすべてのキーが以下の情報とともに表示されます：

• ラベル: 割り当てた説明的な名前
• 短縮値: 識別用のキーの短縮版
• 作成日時: キーが作成された日時
• 最終使用日時: キーが最後にAPIリクエストに使用された日時

APIキーの取り消し

APIキーを取り消すには：

1. 設定 > チーム > APIキー に移動
2. 取り消したいキーを見つける
3. 取り消し ボタンをクリック
4. 取り消しを確認

APIキーの使用方法

Giselle APIへのリクエスト時に、Authorization ヘッダーにAPIキーを含めます：

curl -X POST https://studio.giselles.ai/api/apps/{appId}/run \
  -H "Authorization: Bearer gsk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"text": "入力テキスト"}'

より良い開発体験のために、認証を自動的に処理する Giselle SDK の使用を検討してください。

セキュリティのベストプラクティス

レート制限

APIリクエストは、チームのプランに基づいてレート制限されます：

レート制限を超えると、APIは 429 Too Many Requests レスポンスを返します。レート制限情報はレスポンスヘッダーに含まれます：

• RateLimit-Limit: 1分あたりの最大リクエスト数
• RateLimit-Remaining: 現在のウィンドウでの残りリクエスト数
• RateLimit-Reset: レート制限がリセットされるUnixタイムスタンプ
• Retry-After: 再試行までの待機秒数（レート制限時）

トラブルシューティング

Unauthorized (401) エラー

401エラーを受け取った場合、以下を確認してください：

• APIキーが正しく完全であること
• キーが取り消されていないこと
• Authorization ヘッダーが正しい形式であること：Bearer <your_api_key>

Rate Limited (429) エラー

レート制限を受けている場合：

• Retry-After ヘッダーで再試行可能な時間を確認
• より高い制限のためにプランのアップグレードを検討
• アプリケーションに指数バックオフを実装

次のステップ

• より簡単なAPI統合のための Giselle SDK の使い方を学ぶ
• API経由で統合する前に Playground でアプリをテストする