Update a key
Changes a key's name, disabled, limit or limit_reset. A body that sets none of them answers 400 invalid_request; include_byok_in_limit and unknown fields are ignored.
curl -X PATCH https://api.llm.buzz/api/v1/keys/{hash} \
-H "Authorization: Bearer $LLM_BUZZ_MANAGEMENT_KEY" \
-H "Content-Type: application/json" \
-d '{
"limit": 10,
"limit_reset": "weekly"
}'{
"data": {
"hash": "...",
"name": "CI key",
"label": "CI key",
"disabled": false,
"created_at": "...",
"updated_at": null,
"expires_at": null,
"last_used_at": null,
"limit": 5,
"limit_remaining": 5,
"limit_reset": "monthly",
"include_byok_in_limit": false,
"usage": 0,
"usage_daily": 0,
"usage_weekly": 0,
"usage_monthly": 0,
"byok_usage": 0,
"byok_usage_daily": 0,
"byok_usage_weekly": 0,
"byok_usage_monthly": 0,
"creator_user_id": "...",
"external_user": null,
"workspace_id": "default"
}
}{
"error": {
"code": 400,
"message": "...",
"metadata": {
"error_type": "invalid_request",
"gateway_code": "invalid_parameter",
"param": "limit"
}
}
}{
"error": {
"code": 401,
"message": "Missing Authentication header",
"metadata": {
"error_type": "authentication",
"gateway_code": "missing_authentication"
}
}
}{
"error": {
"code": 403,
"message": "Only management keys can perform this operation; use a management key, created on the console Keys page",
"metadata": {
"error_type": "permission_denied",
"gateway_code": "management_key_required"
}
}
}{
"error": {
"code": 404,
"message": "No API key has this hash. GET /api/v1/keys lists the keys you manage.",
"metadata": {
"error_type": "not_found",
"gateway_code": "key_not_found",
"param": "hash"
}
}
}Authorization
A management key, created on the console's Keys page, as Authorization: Bearer KEY. The samples read it from $LLM_BUZZ_MANAGEMENT_KEY; an inference key gets 403 management_key_required.
Parameters
hashstringpathrequiredThe key's
hash, asGET /api/v1/keyslists it.
Body application/json
namestring1 to 64 characters.
disabledbooleantruedisables the key,falseenables it again.limitnumberA spending limit in US dollars, at most nine decimal places;
nullfor none.limit_resetstringThe limit's period in UTC, a week starting on Monday;
nullcounts the key's whole life.dailyweeklymonthly
Response 200
The changed key, as {"data": ...}.
Errors
400The body is not JSON (
invalid_json), a field or query value is invalid (invalid_parameter, withmetadata.param), or aPATCHsets no field (invalid_request).401No
Authorizationheader (missing_authentication), or the key is unknown, expired, revoked or disabled (invalid_key).403An inference key called a route that takes a management key. Create one on the console's Keys page.
404The hash names none of your inference keys.