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

​
Visão geral

Obtenha a configuração atual do limite de créditos de add-on por usuário da sua organização. Os limites são sempre por usuário. Ao consultar por escopo de equipe ou grupo, a resposta retorna o limite por usuário que foi aplicado aos usuários daquela equipe ou grupo.

​
Requisição

​
service_key
string
obrigatório
Sua Service Key com permissões de Cobrança Read

​
Configuração de escopo (escolha uma opção)

​
team_level
boolean
Defina como true para recuperar o limite por usuário aplicado a todos os usuários da equipe
​
group_id
string
Recupere o limite por usuário aplicado a todos os usuários de um grupo específico fornecendo o ID desse grupo
​
user_email
string
Recupere a configuração de um usuário específico fornecendo o endereço de e-mail desse usuário
Você deve fornecer um dos valores team_level, group_id ou user_email para definir o escopo.

​
Exemplo de requisição - Obter limite por usuário para todos os membros da equipe

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

​
Exemplo de requisição - Obter limite individual para todos os usuários de um grupo

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

​
Exemplo de requisição - Obter configuração do usuário

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

​
Resposta

​
addOnCreditCap
integer
O valor configurado para o limite de créditos do add-on. Se este campo não estiver presente na resposta, não há nenhum limite configurado para o nível de escopo solicitado.

​
Resposta de exemplo - com limite definido

{
  "addOnCreditCap": 10000
}

​
Exemplo de resposta – nenhum limite configurado

{}

​
Respostas de erro

Cenários de erro comuns:
  • Service Key inválida ou permissões insuficientes
  • Múltiplos parâmetros de escopo fornecidos
  • Nenhum parâmetro de escopo fornecido
  • ID de grupo inválido ou e-mail de usuário inválido
  • Limite de requisições excedido