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

# APIリファレンス

> サービスキー認証を使用してDevin Desktopの使用量データをクエリし、設定を管理するためのEnterprise API。

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

Devin Desktop API を使用すると、Enterprise のお客様は、チームの詳細な使用量分析データにプログラムからアクセスし、使用量の設定を管理できます。

<Note>この API は Enterprise プランでのみ利用できます</Note>

<div id="base-url">
  ## Base URL
</div>

すべてのAPIリクエストは、次のURLに送信してください：

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

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

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

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

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

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

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

| エンドポイント                                                                                                | 必要な権限           |
| ------------------------------------------------------------------------------------------------------ | --------------- |
| [カスタム分析](/ja/desktop/accounts/api-reference/custom-analytics) (`/Analytics`)                           | Analytics Read  |
| [ユーザーページ分析](/ja/desktop/accounts/api-reference/user-page-analytics) (`/UserPageAnalytics`)             | Teams Read-Only |
| [カスケード分析](/ja/desktop/accounts/api-reference/cascade-analytics) (`/CascadeAnalytics`)                  | Teams Read-Only |
| [使用量設定](/ja/desktop/accounts/api-reference/usage-config) (`/UsageConfig`)                              | Billing Write   |
| [使用量設定の取得](/ja/desktop/accounts/api-reference/get-usage-config) (`/GetUsageConfig`)                    | Billing Read    |
| [チームのクレジット残高の取得](/ja/desktop/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 に関するサポートやご質問は、[Devin Desktop Support](https://windsurf.com/support) までお問い合わせください。