跳转到主要内容

​
概览

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

​
基础 URL

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

​
身份验证

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

​
创建服务密钥

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

​
所需权限

不同的 API 端点所需的权限各不相同。请参阅各端点的文档以了解其所需的具体权限：
端点所需权限
Custom Analytics (/Analytics)Analytics Read
User Page Analytics (/UserPageAnalytics)Teams Read-Only
Cascade Analytics (/CascadeAnalytics)Teams Read-Only
Set Usage Configuration (/UsageConfig)Billing Write
Get Usage Configuration (/GetUsageConfig)Billing Read

​
使用服务密钥

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

​
速率限制

API 请求受到速率限制，以确保服务稳定性。如果超出速率限制，你将收到 429 请求过多 响应。

​
支持

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