> ## 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 用量数据并管理配置的企业 API。

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

Devin Desktop API 让 Enterprise 客户能够通过编程方式访问详细的用量分析数据，并管理其团队的用量配置。

<Note>该 API 仅适用于 Enterprise 套餐</Note>

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

所有 API 请求都应发送至：

```
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 端点需要不同的权限。请参阅各个端点的文档，了解所需的具体权限：

| 端点 | 所需权限 |
| - | - |
| [自定义分析](/zh/desktop/accounts/api-reference/custom-analytics) (`/Analytics`) | Analytics Read |
| [用户页面分析](/zh/desktop/accounts/api-reference/user-page-analytics) (`/UserPageAnalytics`) | Teams Read-Only |
| [Cascade 分析](/zh/desktop/accounts/api-reference/cascade-analytics) (`/CascadeAnalytics`) | Teams Read-Only |
| [设置用量配置](/zh/desktop/accounts/api-reference/usage-config) (`/UsageConfig`) | Billing Write |
| [获取用量配置](/zh/desktop/accounts/api-reference/get-usage-config) (`/GetUsageConfig`) | Billing Read |
| [获取团队额度余额](/zh/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="models-api">
  ### Models API
</div>

[列出 Models](/zh/desktop/accounts/api-reference/list-models) (`GET https://server.codeium.com/api/v2alpha/models`) 不在 `/api/v1/` 基础 URL 下，其身份验证方式也有所不同：需通过 `Authorization: Bearer <api-key>` 传入 Devin 服务用户 API 密钥，而不是在请求体中传入服务密钥。

<div id="rate-limits">
  ## 速率限制
</div>

为确保服务稳定性，API 请求会受到速率限制。如果你超出速率限制，将收到 `429 Too Many Requests` 响应。

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

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.