Passer au contenu principal
POST
/
api
/
v1
/
GetUsageConfig
Obtenir la configuration d’utilisation
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
}

​
Vue d’ensemble

Récupérez la configuration actuelle du plafond de crédits d’add-on par utilisateur pour votre organisation. Les plafonds sont toujours définis par utilisateur. Lorsque vous interrogez par périmètre d’équipe ou de groupe, la réponse renvoie le plafond par utilisateur qui a été appliqué aux utilisateurs au sein de cette équipe ou de ce groupe.

​
Requête

​
service_key
string
requis
Votre clé de service avec les autorisations « Billing Read »

​
Configuration de la portée (Choisissez-en une)

​
team_level
boolean
Définissez la valeur sur true pour récupérer le plafond par utilisateur appliqué à tous les utilisateurs de l’équipe
​
group_id
string
Récupérez le plafond par utilisateur appliqué à tous les utilisateurs d’un groupe spécifique en fournissant l’ID du groupe
​
user_email
string
Récupérez la configuration pour un utilisateur spécifique en fournissant son adresse e-mail
Vous devez fournir l’un des paramètres team_level, group_id ou user_email pour définir la portée.

​
Exemple de requête - Obtenir la limite par utilisateur pour tous les membres de l’équipe

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

​
Exemple de requête - Récupérer le plafond par utilisateur pour tous les utilisateurs d’un groupe

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

​
Exemple de requête - Récupérer la configuration utilisateur

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

​
Réponse

​
addOnCreditCap
integer
Valeur configurée du plafond de crédits de l’add-on. Si ce champ n’est pas présent dans la réponse, aucun plafond n’est configuré au niveau de périmètre demandé.

​
Exemple de réponse - avec un plafond configuré

{
  "addOnCreditCap": 10000
}

​
Exemple de réponse - Aucun plafond défini

{}

​
Réponses d’erreur

Scénarios d’erreur courants :
  • Clé de service invalide ou autorisations insuffisantes
  • Plusieurs paramètres de scope fournis
  • Aucun paramètre de scope fourni
  • ID de groupe ou adresse e-mail utilisateur invalide
  • Limite de requêtes dépassée