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

​
Resumen

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

​
Solicitud

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

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

​
team_level
boolean
Establézcalo 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 ámbito.

​
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: GET del límite por usuario para 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

​
Solicitud de ejemplo - GET de la configuración del 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 para el límite de créditos adicionales. Si este campo no está presente en la respuesta, no hay ningún límite configurado para el nivel de ámbito solicitado.

​
Respuesta de ejemplo - Con límite configurado

{
  "addOnCreditCap": 10000
}

​
Respuesta de ejemplo - No hay límite configurado

{}

​
Respuestas de error

Escenarios de error comunes:
  • Clave de servicio no válida o permisos insuficientes
  • Se proporcionaron múltiples parámetros de ámbito
  • No se proporcionó ningún parámetro de ámbito
  • ID de grupo o correo electrónico del usuario no válidos
  • Se superó el límite de solicitudes