Passer au contenu principal
POST
/
api
/
v1
/
UsageConfig
Définir la configuration d’utilisation
curl --request POST \
  --url https://server.codeium.com/api/v1/UsageConfig \
  --header 'Authorization: Bearer <token>' \
  --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>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.devin.ai/llms.txt

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

​
Vue d’ensemble

Définissez ou supprimez des plafonds d’utilisation par utilisateur pour les crédits additionnels de votre organisation. Les plafonds s’appliquent toujours par utilisateur. Lorsque vous définissez le périmètre d’une Team ou d’un groupe, le plafond s’applique individuellement à chaque utilisateur de cette Team ou de ce groupe ; il ne définit pas de plafond partagé pour l’ensemble de la Team ou du groupe.

​
Requête

​
service_key
string
requis
Votre clé de service disposant des autorisations « Billing Write »

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

​
clear_add_on_credit_cap
boolean
Définissez sur true pour supprimer 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 du périmètre (choisissez une option)

​
team_level
boolean
Définissez sur true pour appliquer le plafond par utilisateur à tous les utilisateurs de la Team
​
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 des paramètres team_level, group_id ou user_email pour définir le périmètre.

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

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 le plafond de crédit par utilisateur pour tous les 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 un plafond de crédit pour 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 - Supprimer le plafond de crédit

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 200 indique que l’opération a réussi.

​
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 sont tous deux fournis
  • Ni clear_add_on_credit_cap ni set_add_on_credit_cap ne sont fournis
  • Plusieurs paramètres de périmètre ont été fournis
  • Aucun paramètre de périmètre n’a été fourni
  • ID du groupe ou adresse e-mail d’utilisateur invalide
  • Limite de requêtes dépassée