Pular para o conteúdo principal
POST
/
api
/
v1
/
UsageConfig
Definir configuração de uso
curl --request POST \
  --url https://server.codeium.com/api/v1/UsageConfig \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>",
  "clear_add_on_credit_cap": true,
  "set_add_on_credit_cap": 123,
  "team_level": true,
  "group_id": "<string>",
  "user_email": "<string>"
}
'

​
Visão geral

Defina ou remova limites de uso por usuário em créditos de complementos para sua organização. Os limites são sempre aplicados individualmente, por usuário. Quando você especifica um escopo de equipe ou grupo, o limite é aplicado individualmente a cada usuário dentro dessa equipe ou grupo — ele não define um limite compartilhado para toda a equipe ou grupo.

​
Solicitação

​
service_key
string
obrigatório
Sua Chave de serviço com permissões de “Cobrança Write”

​
Configuração do limite de crédito (escolha uma)

​
clear_add_on_credit_cap
boolean
Defina como true para limpar o limite de crédito do add-on existente
​
set_add_on_credit_cap
integer
Defina um novo limite de crédito do add-on (valor inteiro)
Você deve fornecer clear_add_on_credit_cap ou set_add_on_credit_cap, mas não ambos.

​
Configuração de escopo (escolha uma)

​
team_level
boolean
Defina como true para aplicar o limite por usuário a todos os usuários da equipe
​
group_id
string
Aplique o limite por usuário a todos os usuários de um grupo específico informando o ID do grupo
​
user_email
string
Aplique a configuração a um usuário específico informando o endereço de e‑mail desse usuário
Você deve fornecer um de team_level, group_id ou user_email para definir o escopo.

​
Exemplo de solicitação — Definir limite de créditos por usuário para todos os membros da equipe

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "sua_service_key_aqui",
  "set_add_on_credit_cap": 10000,
  "team_level": true
}' \
https://server.codeium.com/api/v1/UsageConfig

​
Exemplo de Solicitação - Definir Limite de Crédito por Usuário para Todos os Usuários em um Grupo

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "set_add_on_credit_cap": 5000,
  "group_id": "engineering_team"
}' \
https://server.codeium.com/api/v1/UsageConfig

​
Exemplo de requisição - Definir limite de crédito para o usuário

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "set_add_on_credit_cap": 1000,
  "user_email": "user@example.com"
}' \
https://server.codeium.com/api/v1/UsageConfig

​
Exemplo de requisição - Limpar limite de crédito

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "clear_add_on_credit_cap": true,
  "team_level": true
}' \
https://server.codeium.com/api/v1/UsageConfig

​
Resposta

O corpo da resposta está vazio. Um código de status 200 indica que a operação foi concluída com sucesso.

​
Respostas de erro

Cenários de erro comuns:
  • Chave de serviço inválida ou permissões insuficientes
  • Ambos clear_add_on_credit_cap e set_add_on_credit_cap fornecidos
  • Nem clear_add_on_credit_cap nem set_add_on_credit_cap fornecidos
  • Vários parâmetros de escopo fornecidos
  • Nenhum parâmetro de escopo fornecido
  • ID do grupo inválido ou e-mail do usuário inválido
  • Limite de frequência excedido