> ## 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.

# Referência da API

> API Enterprise para consultar dados de uso do Windsurf e gerenciar configurações com autenticação por Service Key.

<div id="overview">
  ## Visão geral
</div>

A API do Windsurf permite que clientes Enterprise acessem, de forma programática, Analytics detalhados de uso e gerenciem as configurações de uso de suas equipes.

<Note>A API está disponível apenas para planos Enterprise</Note>

<div id="base-url">
  ## URL base
</div>

Todas as requisições à API devem ser feitas para:

```
https://server.codeium.com/api/v1/
```

<div id="authentication">
  ## Autenticação
</div>

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

<div id="creating-a-service-key">
  ### Criando uma Chave de serviço
</div>

1. Acesse a sua [página de configurações da equipe](https://windsurf.com/team/settings)
2. Vá para 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

<div id="required-permissions">
  ### Permissões necessárias
</div>

Diferentes endpoints de API exigem permissões diferentes. Consulte a documentação de cada endpoint para ver a permissão específica necessária:

| Endpoint                                                                                                           | Permissão necessária  |
| ------------------------------------------------------------------------------------------------------------------ | --------------------- |
| [Custom Analytics](/pt-BR/plugins/accounts/api-reference/custom-analytics) (`/Analytics`)                          | Leitura de Analytics  |
| [User Page Analytics](/pt-BR/plugins/accounts/api-reference/user-page-analytics) (`/UserPageAnalytics`)            | Teams somente leitura |
| [Cascade Analytics](/pt-BR/plugins/accounts/api-reference/cascade-analytics) (`/CascadeAnalytics`)                 | Teams somente leitura |
| [Set Usage Configuration](/pt-BR/plugins/accounts/api-reference/usage-config) (`/UsageConfig`)                     | Gravação de Cobrança  |
| [Get Usage Configuration](/pt-BR/plugins/accounts/api-reference/get-usage-config) (`/GetUsageConfig`)              | Leitura de Cobrança   |
| [Get Team Credit Balance](/pt-BR/plugins/accounts/api-reference/get-team-credit-balance) (`/GetTeamCreditBalance`) | Leitura de Cobrança   |

<div id="using-service-keys">
  ### Usando Chaves de serviço
</div>

Inclua sua Service Key no corpo da requisição em todas as chamadas de API:

```json theme={null}
{
  "service_key": "your_service_key_here",
  // ... outros parâmetros
}
```

<Warning>Mantenha suas Service Keys seguras e nunca as exponha em código cliente ou em repositórios públicos</Warning>

<div id="rate-limits">
  ## Limites de taxa
</div>

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

<div id="support">
  ## Suporte
</div>

Para obter suporte à API ou tirar dúvidas, entre em contato com o [Windsurf Support](https://windsurf.com/support).