Vai al contenuto principale
PATCH
/
api_keys
/api/v1/api_keys
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",
  "description": "Updated API Key Name",
  "expiresAt": "2023-10-01T12:00:00.000Z"
}
'
{
  "data": {
    "apiKeyType": "ADMIN",
    "consumptionLimits": {
      "usd": 50,
      "diem": 10,
      "vcu": 30
    },
    "limitPeriod": "MONTH",
    "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
}

Autorizzazioni

​
Authorization
string
header
obbligatorio

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

Corpo

application/json

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

​
id
string
obbligatorio

The API Key ID to update

Esempio:

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

​
consumptionLimit
object

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

Esempio:
{ "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.

Opzioni disponibili:
EPOCH,
MONTH,
LIFETIME
Esempio:

"MONTH"

​
description
string

The API Key description

Esempio:

"Updated API Key Name"

​
expiresAt

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

Opzioni disponibili:
Esempio:

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

Risposta

OK

​
data
object
obbligatorio
​
success
boolean
obbligatorio