> ## 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 参考

> 面向 Enterprise 的 API，用于查询 Windsurf 使用数据，并使用服务密钥认证来管理配置。

<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](/zh/windsurf/accounts/api-reference/custom-analytics) (`/Analytics`)                          | Analytics Read  |
| [User Page Analytics](/zh/windsurf/accounts/api-reference/user-page-analytics) (`/UserPageAnalytics`)            | Teams Read-Only |
| [Cascade Analytics](/zh/windsurf/accounts/api-reference/cascade-analytics) (`/CascadeAnalytics`)                 | Teams Read-Only |
| [Set Usage Configuration](/zh/windsurf/accounts/api-reference/usage-config) (`/UsageConfig`)                     | Billing Write   |
| [Get Usage Configuration](/zh/windsurf/accounts/api-reference/get-usage-config) (`/GetUsageConfig`)              | Billing Read    |
| [Get Team Credit Balance](/zh/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 请求过多` 响应。

<div id="support">
  ## 支持
</div>

如需 API 支持或有任何疑问，请联系 [Windsurf 支持](https://windsurf.com/support)。