跳转到主要内容

​
概览

Windsurf API 使 Enterprise 客户能够以编程方式访问详细的使用 Analytics 数据，并为其团队管理使用配置。
该 API 仅适用于 Enterprise 方案

​
基础 URL

所有 API 请求应发送至： 
https://server.codeium.com/api/v1/

​
身份验证

Windsurf API 使用服务密钥进行身份验证。所有 API 调用都必须在请求正文中包含服务密钥。

​
创建服务密钥

  1. 前往您的团队设置页面
  2. 打开“服务密钥”部分
  3. 使用合适的权限创建新的服务密钥
  4. 复制生成的服务密钥用于 API 请求

​
所需权限

所有 Analytics API 端点都需要“Teams Read-only”权限。 所有 Usage API 端点都需要“Billing Write”权限。

​
使用服务密钥

在所有 API 调用中，将你的服务密钥放入请求正文： 
{
  "service_key": "your_service_key_here",
  // ... 其他参数
}
请妥善保管你的服务密钥，切勿在客户端代码或公共代码库中暴露

​
速率限制

为确保服务稳定性，API 请求会受速率限制。如果超过限制，将返回 429 Too Many Requests 响应。

​
支持

如需 API 支持或有任何疑问，请联系 Windsurf 支持。