Pular para o conteúdo principal

​
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 Service Keys para autenticação. As Service Keys devem ser incluídas no corpo da requisição de todas as chamadas à 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

Todos os endpoints da Analytics API exigem a permissão “Teams somente leitura”. Todos os endpoints da Usage API exigem a permissão “Billing Write”.

​
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 controle de taxa para garantir a estabilidade do serviço. Se você exceder o limite, receberá uma resposta 429 Too Many Requests.

​
Suporte

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