> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devin.ai/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 Devin Desktop e gerenciar configurações com autenticação por chave de serviço.

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

A API do Devin Desktop permite que clientes corporativos acessem programaticamente análises detalhadas de uso e gerenciem configurações de uso para suas equipes.

<Note>A API está disponível apenas nos 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 Devin Desktop 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 à API.

<div id="creating-a-service-key">
  ### Como criar uma chave de serviço
</div>

1. Acesse a [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 adequadas
4. Copie a chave de serviço gerada para usá-la em requisições de API

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

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

| Endpoint                                                                                                                     | Permissão obrigatória  |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------- |
| [Análises personalizadas](/pt-BR/desktop/accounts/api-reference/custom-analytics) (`/Analytics`)                             | Leitura de análises    |
| [Análises da página do usuário](/pt-BR/desktop/accounts/api-reference/user-page-analytics) (`/UserPageAnalytics`)            | Teams: somente leitura |
| [Análises do Cascade](/pt-BR/desktop/accounts/api-reference/cascade-analytics) (`/CascadeAnalytics`)                         | Teams: somente leitura |
| [Definir configuração de uso](/pt-BR/desktop/accounts/api-reference/usage-config) (`/UsageConfig`)                           | Billing: gravação      |
| [Obter configuração de uso](/pt-BR/desktop/accounts/api-reference/get-usage-config) (`/GetUsageConfig`)                      | Billing: leitura       |
| [Obter saldo de créditos da equipe](/pt-BR/desktop/accounts/api-reference/get-team-credit-balance) (`/GetTeamCreditBalance`) | Billing: leitura       |

<div id="using-service-keys">
  ### Como usar chaves de serviço
</div>

Inclua sua chave de serviço no corpo da requisição de todas as chamadas à API:

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

<Warning>Mantenha suas chaves de serviço seguras e nunca as exponha em código do lado do 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 o limite de taxa, receberá uma resposta `429 Too Many Requests`.

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

Para obter suporte e esclarecer dúvidas sobre a API, entre em contato com o [Suporte do Devin Desktop](https://windsurf.com/support).