> ## 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 リクエストは次の URL に送信してください:

```
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 エンドポイントごとに必要な権限は異なります。各エンドポイントに必要な権限の詳細は、それぞれのエンドポイントのドキュメントを参照してください。

| Endpoint                                                                                               | 必要な権限           |
| ------------------------------------------------------------------------------------------------------ | --------------- |
| [カスタム Analytics](/ja/windsurf/accounts/api-reference/custom-analytics) (`/Analytics`)                  | Analytics Read  |
| [ユーザーページ Analytics](/ja/windsurf/accounts/api-reference/user-page-analytics) (`/UserPageAnalytics`)    | Teams Read-Only |
| [Cascade Analytics](/ja/windsurf/accounts/api-reference/cascade-analytics) (`/CascadeAnalytics`)       | Teams Read-Only |
| [利用状況設定の変更](/ja/windsurf/accounts/api-reference/usage-config) (`/UsageConfig`)                         | Billing Write   |
| [利用状況設定の取得](/ja/windsurf/accounts/api-reference/get-usage-config) (`/GetUsageConfig`)                  | Billing Read    |
| [チームクレジット残高の取得](/ja/windsurf/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) までお問い合わせください。