Skip to main content
POST
https://server.codeium.com
/
api
/
v1
/
GetUsageConfig
Obtener la 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>"
}
'
{
  "add_on_credit_cap": 123
}

​
Descripción general

Obtén la configuración actual del límite de créditos de complementos para tu organización. Puedes consultar configuraciones a nivel de equipo, para grupos específicos o para usuarios individuales.

​
Solicitud

​
service_key
string
required
Tu clave de servicio con permisos de “Billing Read”

​
Configuración del ámbito (elige una opción)

​
team_level
boolean
Establece en true para obtener la configuración a nivel de equipo
​
group_id
string
Obtén la configuración de un grupo específico proporcionando el ID de grupo
​
user_email
string
Obtén la configuración de un usuario específico proporcionando su dirección de correo electrónico
Debes proporcionar uno de team_level, group_id o user_email para definir el ámbito.

​
Ejemplo de solicitud: obtener la configuración a nivel de 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 la configuración 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 configuración de usuario

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "user_email": "[email protected]"
}' \
https://server.codeium.com/api/v1/GetUsageConfig

​
Respuesta

​
add_on_credit_cap
integer
El valor configurado del límite de créditos del complemento. Si este campo no está presente en la respuesta, no hay ningún límite configurado para el nivel de alcance solicitado.

​
Ejemplo de respuesta - con límite configurado

{
  "add_on_credit_cap": 10000
}

​
Ejemplo de respuesta: sin tope configurado

{}

​
Respuestas de error

Escenarios de error comunes:
  • Clave de servicio no válida o permisos insuficientes
  • Se proporcionaron varios parámetros de scope
  • No se proporcionó ningún parámetro de scope
  • ID de grupo no válido o correo electrónico de usuario no válido
  • Límite de solicitudes superado