> ## Documentation Index
> Fetch the complete documentation index at: https://docs.windsurf.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API リファレンス

> Windsurf の利用データの照会と構成管理のための、サービスキー認証に対応した Enterprise API

<div id="overview">
  ## 概要
</div>

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

<Note>この API は Enterprise プランでのみご利用いただけます</Note>

<div id="base-url">
  ## ベースURL
</div>

すべての API リクエストは次のエンドポイントに送信してください：

```
https://server.codeium.com/api/v1/
```

<div id="authentication">
  ## 認証
</div>

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

<div id="creating-a-service-key">
  ### サービス キーの作成
</div>

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

<div id="required-permissions">
  ### 必要な権限
</div>

API エンドポイントごとに必要な権限は異なります。必要な権限については、各エンドポイントのドキュメントを参照してください。

| エンドポイント                                                                                                         | 必要な権限           |
| --------------------------------------------------------------------------------------------------------------- | --------------- |
| [Custom Analytics](/ja/plugins/accounts/api-reference/custom-analytics) (`/Analytics`)                          | Analytics Read  |
| [User Page Analytics](/ja/plugins/accounts/api-reference/user-page-analytics) (`/UserPageAnalytics`)            | Teams Read-only |
| [Cascade Analytics](/ja/plugins/accounts/api-reference/cascade-analytics) (`/CascadeAnalytics`)                 | Teams Read-only |
| [Set Usage Configuration](/ja/plugins/accounts/api-reference/usage-config) (`/UsageConfig`)                     | Billing Write   |
| [Get Usage Configuration](/ja/plugins/accounts/api-reference/get-usage-config) (`/GetUsageConfig`)              | Billing Read    |
| [Get Team Credit Balance](/ja/plugins/accounts/api-reference/get-team-credit-balance) (`/GetTeamCreditBalance`) | Billing Read    |

<div id="using-service-keys">
  ### サービス キーの使用
</div>

すべての API 呼び出しで、リクエスト本文にサービスキーを含めてください。

```json theme={null}
{
  "service_key": "your_service_key_here",
  // ... その他のパラメータ
}
```

<Warning>サービスキーは厳重に管理し、クライアント側のコードや公開リポジトリで決して露出させないでください</Warning>

<div id="rate-limits">
  ## レート制限
</div>

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

<div id="support">
  ## サポート
</div>

API に関するサポートやご質問は、[Windsurf Support](https://windsurf.com/support) までお問い合わせください。