Passer au contenu principal
POST
/
api
/
v1
/
UsageConfig
Configurer l’utilisation
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>"
}
'

​
Vue d’ensemble

Définissez ou effacez des plafonds d’utilisation par utilisateur sur les crédits d’add-on pour votre organisation. Les plafonds sont toujours appliqués utilisateur par utilisateur. Lorsque vous spécifiez un périmètre d’équipe ou de groupe, le plafond est appliqué individuellement à chaque utilisateur au sein de cette équipe ou de ce groupe — il ne définit pas un plafond partagé pour l’ensemble de l’équipe ou du groupe.

​
Requête

​
service_key
string
requis
Votre clé de service avec les permissions « Facturation Write »

​
Configuration du plafond de crédits (Choisissez une option)

​
clear_add_on_credit_cap
boolean
Définissez sur true pour réinitialiser le plafond de crédits additionnels existant
​
set_add_on_credit_cap
integer
Définissez un nouveau plafond de crédits additionnels (valeur entière)
Vous devez fournir soit clear_add_on_credit_cap, soit set_add_on_credit_cap, mais pas les deux.

​
Configuration de la portée (choisir une option)

​
team_level
boolean
Définissez sur true pour appliquer le plafond par utilisateur à tous les utilisateurs de l’équipe
​
group_id
string
Appliquez le plafond par utilisateur à tous les utilisateurs d’un groupe spécifique en fournissant l’ID du groupe
​
user_email
string
Appliquez la configuration à un utilisateur spécifique en fournissant son adresse e‑mail
Vous devez fournir l’un de team_level, group_id ou user_email pour définir la portée.

​
Exemple de requête – Définir le plafond de crédits par utilisateur pour tous les membres de l’équipe

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

​
Exemple de requête - Définir un plafond de crédit par utilisateur pour l’ensemble des utilisateurs d’un groupe

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

​
Exemple de requête - Définir le plafond de crédit d’un utilisateur

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

​
Exemple de requête - Suppression du plafond de crédits

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

​
Réponse

Le corps de la réponse est vide. Un code d’état HTTP 200 indique que l’opération s’est déroulée avec succès.

​
Réponses d’erreur

Scénarios d’erreur courants :
  • Clé de service invalide ou autorisations insuffisantes
  • clear_add_on_credit_cap et set_add_on_credit_cap fournis tous les deux
  • Ni clear_add_on_credit_cap ni set_add_on_credit_cap fournis
  • Plusieurs paramètres de portée fournis
  • Aucun paramètre de portée fourni
  • ID de groupe ou e-mail d’utilisateur invalide
  • Limite de taux dépassée