Saltar al contenido principal
POST
/
api
/
v1
/
GetUsageConfig
Obtener configuración 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
}

​
Descripción general

Obtén la configuración actual del límite de créditos de complementos por usuario para tu organización. Los límites siempre son por usuario. Cuando consultas por el ámbito de un equipo o grupo, la respuesta devuelve el límite por usuario que se ha aplicado a los usuarios dentro de ese equipo o grupo.

​
Solicitud

​
service_key
string
requerido
Tu clave de servicio con el permiso “Billing Read”

​
Configuración del alcance (elija una)

​
team_level
boolean
Configúrelo en true para obtener el límite por usuario aplicado a todos los usuarios del equipo
​
group_id
string
Obtenga el límite por usuario aplicado a todos los usuarios de un grupo específico proporcionando el ID del grupo
​
user_email
string
Obtenga la configuración de un usuario específico proporcionando su dirección de correo electrónico
Debe proporcionar uno de team_level, group_id o user_email para definir el alcance.

​
Ejemplo de solicitud: obtener el límite por usuario para todos los usuarios del equipo

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

​
Ejemplo de solicitud: Obtener el límite por usuario de todos los usuarios de un 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

​
Ejemplo de solicitud: obtener la configuración de usuario

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

​
Respuesta

​
addOnCreditCap
integer
El valor configurado del tope de créditos del complemento. Si este campo no está presente en la respuesta, no hay ningún tope configurado en el ámbito solicitado.

​
Ejemplo de respuesta: con límite establecido

{
  "addOnCreditCap": 10000
}

​
Ejemplo de respuesta - sin límite establecido

{}

​
Respuestas de error

Escenarios de error habituales:
  • Clave de servicio no válida o permisos insuficientes
  • Se proporcionaron varios parámetros scope
  • No se proporcionó ningún parámetro scope
  • ID de grupo o correo electrónico de usuario no válido
  • Se superó el límite de solicitudes (rate limit)