Passer au contenu principal
POST
/
api
/
v1
/
GetUsageConfig
Récupérer la configuration d’utilisation
curl --request POST \
  --url https://server.codeium.com/api/v1/GetUsageConfig \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>",
  "team_level": true,
  "group_id": "<string>",
  "user_email": "<string>"
}
'
{
  "addOnCreditCap": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.devinenterprise.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Vue d’ensemble

Récupérez la configuration actuelle du plafond de crédits additionnels par utilisateur pour votre organisation. Les plafonds sont toujours définis par utilisateur. Lorsque vous effectuez une requête sur le périmètre d’une Team ou d’un groupe, la réponse renvoie le plafond par utilisateur appliqué aux utilisateurs de cette Team ou de ce groupe.

​
Requête

​
service_key
string
requis
Votre clé de service avec l’autorisation « Billing Read »

​
Configuration du périmètre (choisissez une option)

​
team_level
boolean
Définissez cette valeur sur true pour récupérer le plafond par utilisateur appliqué à tous les utilisateurs de la Team
​
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 d’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 le périmètre.

​
Exemple de requête - Récupérer le plafond par utilisateur pour tous les utilisateurs de la Team

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 l’ensemble des 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
La valeur configurée du plafond de crédits additionnel. Si ce champ n’est pas présent dans la réponse, aucun plafond n’est configuré pour le niveau de périmètre demandé.

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

{
  "addOnCreditCap": 10000
}

​
Exemple de réponse - Aucun plafond n’est configuré

{}

​
Réponses d’erreur

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