Skip to main content

​
Overview

The Windsurf API enables enterprise customers to programmatically access detailed usage analytics and manage usage configurations for their teams.
The API is available for Enterprise plans only

​
Base URL

All API requests should be made to: 
https://server.codeium.com/api/v1/

​
Authentication

The Windsurf API uses service keys for authentication. Service keys must be included in the request body of all API calls.

​
Creating a Service Key

  1. Navigate to your team settings page
  2. Go to the “Service Keys” section
  3. Create a new service key with appropriate permissions
  4. Copy the generated service key for use in API requests

​
Required Permissions

Different API endpoints require different permissions. Refer to the individual endpoint documentation for the specific permission required:
EndpointRequired Permission
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

​
Using Service Keys

Include your service key in the request body of all API calls: 
{
  "service_key": "your_service_key_here",
  // ... other parameters
}
Keep your service keys secure and never expose them in client-side code or public repositories

​
Rate Limits

API requests are subject to rate limiting to ensure service stability. If you exceed the rate limit, you’ll receive a 429 Too Many Requests response.

​
Support

For API support and questions, please contact Windsurf Support.