Set or clear an API key's monthly overage cap

Change how many overage credits this key may take on per calendar month (UTC). A positive number sets the cap; an explicit null, or a body without the field, clears it. The cap bounds only overage: work the prepaid balance fully covers is never refused by it.

patch/v1/keys/{key_id}

Request

  • Base URL: https://thirds.ai
  • URL: https://thirds.ai/v1/keys/{key_id}
  • Auth: HTTP bearer

Path parameters

key_idstring required

The key's public identifier, such as "key_1f8b3c7d5e2a49061f8b3c7d5e2a4906".

Request body

namestring

New key name. The key secret and prefix stay the same.

monthly_overage_capinteger nullable

The most overage credits this key may take on per calendar month (UTC), or null to clear the cap. Omit it to keep the current cap.

Response

The key with its new cap.

idstring required

The key's public identifier: "key_" followed by 32 lowercase hexadecimal characters.

namestring required
display_prefixstring required

The first characters of the secret, enough to tell keys apart in a list.

status'active' | 'revoked' required
created_atstring date-time required
revoked_atstring date-time nullable required
last_used_atstring date-time nullable required
monthly_overage_capinteger nullable required

The most overage credits this key may take on per calendar month (UTC). Null means the key sets no cap of its own.

Changes

No recorded changes to this operation across all 1 revision of this API.