APaptible
LlmGatewayKeys

update llm_gateway_key

Changed on

Changes a key's handle and/or spend_limit. Nothing else about a key can be changed. Available to the organization's owners and to whoever created the key.

At least one of handle and spend_limit must be sent, and only what is sent changes. Sending a null or blank spend_limit removes the key's limit.

patch/llm_gateway_keys/{id}

Request

  • Base URL
    https://api.aptible.com
  • Auth
    API key in header Authorization

Path parameters

idinteger required

LLM Gateway Key database ID

Query parameters

no_embedboolean

When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.

Headers

Prefer'no_sensitive_extras=true'

When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.

Request body

handlestring

New handle for the key, unique within the organization

spend_limitnumber

New spend limit in USD for this key, or null to remove it. Must not exceed the organization's spend_limit.

Response

successful

idinteger required

Database ID of the LLM Gateway Key

_typestring required
handlestring required

User-provided handle for the key (unique within the organization)

notestring required

User-provided note

spend_limitstring required

Spend limit in USD for this key (decimal, serialized as string). Null means the key has no limit of its own. Never exceeds the organization's spend_limit: lowering that lowers any key that was above it.

organization_idstring required

The organization this key belongs to

created_atstring dateTime required
updated_atstring dateTime required
gateway_urlstring required

Customer-facing LLM Gateway endpoint URL

token_prefixstring required

The first characters of the key's token, safe to display and enough to tell keys apart

created_byobject required

User who created the key

revoked_atstring dateTime required

Timestamp when the key was revoked

revoked_byobject required

User who revoked the key

statusstring required

Key status (ACTIVE or REVOKED)

tokenstring

Secret API key value (only present on creation)

Changes