Saltar al contenido principal
POST
/
api
/
v1
/
UsageConfig
Establecer la configuración de uso
curl --request POST \
  --url https://server.codeium.com/api/v1/UsageConfig \
  --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>"
}
'

​
Descripción general

Configura o elimina límites de uso por usuario para los créditos de complementos de tu organización. Los límites siempre se aplican por usuario. Cuando especificas un ámbito de equipo o grupo, el límite se aplica individualmente a cada usuario dentro de ese equipo o grupo; no establece un límite compartido para todo el equipo o grupo.

​
Solicitud

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

​
Configuración del límite de crédito (Elige una)

​
clear_add_on_credit_cap
boolean
Establécelo en true para borrar el límite de crédito adicional existente
​
set_add_on_credit_cap
integer
Establece un nuevo límite de crédito adicional (valor entero)
Debes proporcionar clear_add_on_credit_cap o set_add_on_credit_cap, pero no ambos.

​
Configuración del alcance (Elige una)

​
team_level
boolean
Configúralo en true para aplicar el límite por usuario a todos los usuarios del equipo
​
group_id
string
Aplica el límite por usuario a todos los usuarios de un grupo específico proporcionando el ID del grupo
​
user_email
string
Aplica la configuración a 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 alcance.

​
Ejemplo de solicitud: establecer un tope de créditos por usuario para todos los usuarios del equipo

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

​
Ejemplo de solicitud: establecer límite de crédito por usuario para todos los usuarios del grupo

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

​
Ejemplo de solicitud: establecer límite de crédito para un usuario

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

​
Ejemplo de solicitud: eliminar el límite de créditos

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

​
Respuesta

El cuerpo de la respuesta está vacío. Un código de estado 200 indica que la operación se completó correctamente.

​
Respuestas de error

Escenarios de error comunes:
  • Clave de servicio no válida o permisos insuficientes
  • Se proporcionaron tanto clear_add_on_credit_cap como set_add_on_credit_cap
  • No se proporcionó ni clear_add_on_credit_cap ni set_add_on_credit_cap
  • Se proporcionaron varios parámetros de scope
  • No se proporcionó ningún parámetro de scope
  • ID de grupo o correo electrónico de usuario no válido
  • Se superó el límite de solicitudes