Create API Key | Venice API Docs

curl --request POST \ --url https://api.venice.ai/api/v1/api_keys \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "apiKeyType": "ADMIN", "description": "Example API Key", "consumptionLimit": { "usd": 50, "diem": 10, "vcu": 30 }, "limitPeriod": "MONTH", "expiresAt": "2023-10-01T12:00:00.000Z" } '

{ "data": { "apiKey": "<string>", "apiKeyType": "ADMIN", "consumptionLimit": { "usd": 50, "diem": 10, "vcu": 30 }, "limitPeriod": "MONTH", "expiresAt": "2023-10-01T12:00:00.000Z", "id": "e28e82dc-9df2-4b47-b726-d0a222ef2ab5", "description": "Example API Key" }, "success": true }

授权

Authorization

string

header

必填

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

请求体

application/json

The request body for creating a new API key. API key creation is rate limited to 20 requests per minute and a maximum of 500 active API keys per user. VCU (Legacy Diem) is being deprecated in favor of tokenized Diem. Please update your API calls to use Diem instead.

apiKeyType

enum<string>

必填

The API Key type. Admin keys have full access to the API while inference keys are only able to call inference endpoints.

可用选项:

INFERENCE,

ADMIN

示例:

"ADMIN"

description

string

必填

The API Key description

示例:

"Example API Key"

consumptionLimit

object

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

Show child attributes

示例:

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

可用选项:

EPOCH,

MONTH,

LIFETIME

示例:

"MONTH"

expiresAt

The API Key expiration date. If not provided, the key will not expire.

可用选项:

示例:

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

响应

data

object

必填

Show child attributes

success

boolean

必填