Pular para o conteúdo principal

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.

​
Visão geral

A API do Windsurf permite que clientes Enterprise acessem programaticamente análises detalhadas de uso e gerenciem as configurações de uso de suas equipes.
A API está disponível apenas para planos Enterprise

​
URL base

Todas as requisições à API devem ser feitas para: 
https://server.codeium.com/api/v1/

​
Autenticação

A API do Windsurf usa chaves de serviço para autenticação. As chaves de serviço devem ser incluídas no corpo da requisição de todas as chamadas de API.

​
Criando uma Chave de serviço

  1. Acesse a sua página de configurações da equipe
  2. Vá até a seção “Chaves de serviço”
  3. Crie uma nova Chave de serviço com as permissões apropriadas
  4. Copie a Chave de serviço gerada para usar em solicitações à API

​
Permissões necessárias

Diferentes endpoints de API exigem permissões diferentes. Consulte a documentação de cada endpoint para saber qual permissão é necessária:
EndpointPermissão necessária
Custom Analytics (/Analytics)Analytics Read
User Page Analytics (/UserPageAnalytics)Teams somente leitura
Cascade Analytics (/CascadeAnalytics)Teams somente leitura
Set Usage Configuration (/UsageConfig)Billing Write
Get Usage Configuration (/GetUsageConfig)Billing Read
Get Team Credit Balance (/GetTeamCreditBalance)Billing Read

​
Usando Chaves de serviço

Inclua sua Service Key no corpo da requisição de todas as chamadas à API: 
{
  "service_key": "your_service_key_here",
  // ... outros parâmetros
}
Mantenha suas chaves de serviço seguras e nunca as exponha em código do lado do cliente ou em repositórios públicos

​
Limites de taxa

As solicitações à API estão sujeitas a limitação de taxa para garantir a estabilidade do serviço. Se você exceder esse limite, receberá uma resposta 429 Too Many Requests.

​
Suporte

Para suporte à API e outras dúvidas, entre em contato com o Windsurf Support.