メインコンテンツへスキップ

​
概要

Windsurf API は、Enterprise のお客様がチームの詳細な利用状況の Analytics にプログラムからアクセスし、利用設定を管理できるようにします。
この API は Enterprise プランでのみご利用いただけます

​
ベースURL

すべての API リクエストは次のエンドポイントに送信してください： 
https://server.codeium.com/api/v1/

​
認証

Windsurf API では認証にサービスキーを使用します。サービスキーは、すべての API 呼び出しのリクエスト ボディに含める必要があります。

​
サービス キーの作成

  1. チーム設定ページに移動します
  2. 「サービス キー」セクションに移動します
  3. 適切な権限で新しいサービスキーを作成します
  4. 生成されたサービスキーをコピーし、API リクエストで使用します

​
必要な権限

API エンドポイントごとに必要な権限は異なります。必要な権限については、各エンドポイントのドキュメントを参照してください。
エンドポイント必要な権限
Custom Analytics (/Analytics)Analytics Read
User Page Analytics (/UserPageAnalytics)Teams Read-only
Cascade Analytics (/CascadeAnalytics)Teams Read-only
Set Usage Configuration (/UsageConfig)Billing Write
Get Usage Configuration (/GetUsageConfig)Billing Read

​
サービス キーの使用

すべての API 呼び出しで、リクエスト本文にサービスキーを含めてください。 
{
  "service_key": "your_service_key_here",
  // ... その他のパラメータ
}
サービスキーは厳重に管理し、クライアント側のコードや公開リポジトリで決して露出させないでください

​
レート制限

サービスの安定性を確保するため、API リクエストにはレート制限が適用されます。レート制限を超過した場合、429 Too Many Requests レスポンスが返されます。

​
サポート

API に関するサポートやご質問は、Windsurf Support までお問い合わせください。