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

​
概要

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

​
ベース URL

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

​
認証

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

​
サービス キーの作成

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

​
必要な権限

API エンドポイントごとに必要な権限は異なります。各エンドポイントに必要な権限の詳細は、それぞれのエンドポイントのドキュメントを参照してください。
Endpoint必要な権限
カスタム Analytics (/Analytics)Analytics Read
ユーザーページ Analytics (/UserPageAnalytics)Teams Read-Only
Cascade Analytics (/CascadeAnalytics)Teams Read-Only
利用状況設定の変更 (/UsageConfig)Billing Write
利用状況設定の取得 (/GetUsageConfig)Billing Read
チームクレジット残高の取得 (/GetTeamCreditBalance)Billing Read

​
サービス キーの使用

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

​
レート制限

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

​
サポート

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