Skip to main content
POST
https://server.codeium.com
/
api
/
v1
/
GetUsageConfig
获取用量配置
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
}

概览

获取你所在组织当前的附加用量额度上限配置。你可以在团队级、特定群组或单个用户级查询这些配置。

请求

service_key
string
required
具有 “Billing Read” 权限的服务密钥

范围配置(任选其一)

team_level
boolean
将其设置为 true 以获取团队级配置
group_id
string
通过提供组 ID 获取该组的配置
user_email
string
通过提供用户的电子邮箱地址获取该用户的配置
必须在 team_levelgroup_iduser_email 中提供一个,以定义配置范围。

示例请求 - 获取团队级别配置

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

示例请求:获取组配置

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

示例请求:获取用户配置

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

响应

add_on_credit_cap
integer
已配置的附加额度上限值。如果响应中不存在此字段,则表示在所请求的作用域级别未配置上限。

示例响应 - 已设置上限

{
  "add_on_credit_cap": 10000
}

示例响应 - 未设置上限

{}

错误响应

常见错误情况:
  • 服务密钥无效或权限不足
  • 提供了多个 scope 参数
  • 未提供 scope 参数
  • 群组 ID 或用户邮箱无效
  • 超出速率限制