Update API Key

Update an existing API key. The description, expiration date, consumption limits, limit period, and model privacy can be updated.

PATCH /api_keys

/api/v1/api_keys

cURL

curl --request PATCH \
  --url https://api.venice.ai/api/v1/api_keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "e28e82dc-9df2-4b47-b726-d0a222ef2ab5",
  "consumptionLimit": {
    "usd": 50,
    "diem": 10,
    "vcu": 30
  },
  "limitPeriod": "MONTH",
  "modelPrivacy": "ALL",
  "description": "Updated API Key Name",
  "expiresAt": "2023-10-01T12:00:00.000Z"
}
'

200

{
  "data": {
    "apiKeyType": "ADMIN",
    "consumptionLimits": {
      "usd": 50,
      "diem": 10,
      "vcu": 30
    },
    "limitPeriod": "MONTH",
    "modelPrivacy": "ALL",
    "createdAt": "2023-10-01T12:00:00.000Z",
    "expiresAt": "2023-10-01T12:00:00.000Z",
    "id": "e28e82dc-9df2-4b47-b726-d0a222ef2ab5",
    "last6Chars": "2V2jNW",
    "lastUsedAt": "2023-10-01T12:00:00.000Z",
    "description": "Updated API Key"
  },
  "success": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The request body for updating an existing API key. The description, expiration date, consumption limits, limit period (epoch / month / lifetime), and model privacy can be updated.

id · string · required

The API Key ID to update

Example:

"e28e82dc-9df2-4b47-b726-d0a222ef2ab5"

consumptionLimit · object

The API Key consumption limits, evaluated against the window selected by limitPeriod.

Show child attributes

Example:

{ "usd": 50, "diem": 10, "vcu": 30 }

limitPeriod · enum<string>

Reset window the consumption limits apply to. EPOCH resets every UTC day (legacy default). MONTH resets on the 1st of each UTC calendar month. LIFETIME never resets, so the limit acts as a permanent cap on the key.

Available options: EPOCH, MONTH, LIFETIME

Example:

"MONTH"

modelPrivacy · enum<string>

Which models this key may call, by privacy tier. ALL allows every model. PRIVATE_TEXT requires text and embedding models to be Private, TEE, or E2EE while other modalities may be Anonymous or Private. PRIVATE_ONLY requires every model to be Private, TEE, or E2EE; Anonymous models are rejected.

Available options: ALL, PRIVATE_TEXT, PRIVATE_ONLY

Example:

"ALL"

description · string

The API Key description (max 64 characters)

Maximum string length: 64

Example:

"Updated API Key Name"

expiresAt · Option 1 · enum<string> null · any Option 3 · string Option 4 · string null · any

The API Key expiration date. Set to empty string or null to remove expiration.

Available options:

Example:

"2023-10-01T12:00:00.000Z"

Response

200

application/json

OK

data · object · required

Show child attributes

success · boolean · required