Generate

Generate Key Fn

Generate an API key based on the provided data.

Docs: https://docs.litellm.ai/docs/proxy/virtual_keys

Parameters:

duration: Optional[str] - Specify the length of time the token is valid for. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d").
key_alias: Optional[str] - User defined key alias
key: Optional[str] - User defined key value. If not set, a 16-digit unique sk-key is created for you.
team_id: Optional[str] - The team id of the key
user_id: Optional[str] - The user id of the key
budget_id: Optional[str] - The budget id associated with the key. Created by calling /budget/new.
models: Optional[list] - Model_name's a user is allowed to call. (if empty, key is allowed to call all models)
aliases: Optional[dict] - Any alias mappings, on top of anything in the config.yaml model list. - https://docs.litellm.ai/docs/proxy/virtual_keys#managing-auth---upgradedowngrade-models
config: Optional[dict] - any key-specific configs, overrides config in config.yaml
spend: Optional[int] - Amount spent by key. Default is 0. Will be updated by proxy whenever key is used. https://docs.litellm.ai/docs/proxy/virtual_keys#managing-auth---tracking-spend
send_invite_email: Optional[bool] - Whether to send an invite email to the user_id, with the generate key
max_budget: Optional[float] - Specify max budget for a given key.
budget_duration: Optional[str] - Budget is reset at the end of specified duration. If not set, budget is never reset. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d").
max_parallel_requests: Optional[int] - Rate limit a user based on the number of parallel requests. Raises 429 error, if user's parallel requests > x.
metadata: Optional[dict] - Metadata for key, store information for key. Example metadata = {"team": "core-infra", "app": "app2", "email": "ishaan@berri.ai" }
guardrails: Optional[List[str]] - List of active guardrails for the key
permissions: Optional[dict] - key-specific permissions. Currently just used for turning off pii masking (if connected). Example - {"pii": false}
model_max_budget: Optional[Dict[str, BudgetConfig]] - Model-specific budgets {"gpt-4": {"budget_limit": 0.0005, "time_period": "30d"}}}. IF null or {} then no model specific budget.
model_rpm_limit: Optional[dict] - key-specific model rpm limit. Example - {"text-davinci-002": 1000, "gpt-3.5-turbo": 1000}. IF null or {} then no model specific rpm limit.
model_tpm_limit: Optional[dict] - key-specific model tpm limit. Example - {"text-davinci-002": 1000, "gpt-3.5-turbo": 1000}. IF null or {} then no model specific tpm limit.
allowed_cache_controls: Optional[list] - List of allowed cache control values. Example - ["no-cache", "no-store"]. See all values - https://docs.litellm.ai/docs/proxy/caching#turn-on--off-caching-per-request
blocked: Optional[bool] - Whether the key is blocked.
rpm_limit: Optional[int] - Specify rpm limit for a given key (Requests per minute)
tpm_limit: Optional[int] - Specify tpm limit for a given key (Tokens per minute)
soft_budget: Optional[float] - Specify soft budget for a given key. Will trigger a slack alert when this soft budget is reached.
tags: Optional[List[str]] - Tags for tracking spend and/or doing tag-based routing.
enforced_params: Optional[List[str]] - List of enforced params for the key (Enterprise only). Docs

Examples:

Allow users to turn on/off pii masking

curl --location 'http://0.0.0.0:4000/key/generate'         --header 'Authorization: Bearer sk-1234'         --header 'Content-Type: application/json'         --data '{
        "permissions": {"allow_pii_controls": true}
}'

Returns:

key: (str) The generated api key
expires: (datetime) Datetime object for when key expires.
user_id: (str) Unique user id - used for tracking spend across multiple keys for same user id.

POST/key/generate

Authorization

Header parameters

Body

key_aliasKey Alias

durationDuration

modelsModels

spendSpend

max_budgetMax Budget

user_idUser Id

team_idTeam Id

max_parallel_requestsMax Parallel Requests

metadataMetadata

tpm_limitTpm Limit

rpm_limitRpm Limit

budget_durationBudget Duration

allowed_cache_controlsAllowed Cache Controls

configConfig

permissionsPermissions

model_max_budgetModel Max Budget

model_rpm_limitModel Rpm Limit

model_tpm_limitModel Tpm Limit

guardrailsGuardrails

blockedBlocked

aliasesAliases

keyKey

budget_idBudget Id

tagsTags

enforced_paramsEnforced Params

soft_budgetSoft Budget

send_invite_emailSend Invite Email

Response

Successful Response

Body

key_aliasKey Alias

durationDuration

modelsModels

spendSpend

max_budgetMax Budget

user_idUser Id

team_idTeam Id

max_parallel_requestsMax Parallel Requests

metadataMetadata

tpm_limitTpm Limit

rpm_limitRpm Limit

budget_durationBudget Duration

allowed_cache_controlsAllowed Cache Controls

configConfig

permissionsPermissions

model_max_budgetModel Max Budget

model_rpm_limitModel Rpm Limit

model_tpm_limitModel Tpm Limit

guardrailsGuardrails

blockedBlocked

aliasesAliases

key*Key

budget_idBudget Id

tagsTags

enforced_paramsEnforced Params

key_nameKey Name

expires*Expires

token_idToken Id

litellm_budget_tableLitellm Budget Table

tokenToken

Request

const response = await fetch('/key/generate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "key_alias": "text",
  "duration": "text",
  "models": [],
  "spend": 0,
  "max_budget": 0,
  "user_id": "text",
  "team_id": "text",
  "max_parallel_requests": 0,
  "tpm_limit": 0,
  "rpm_limit": 0,
  "budget_duration": "text",
  "allowed_cache_controls": [],
  "guardrails": [
    "text"
  ],
  "blocked": false,
  "key": "text",
  "budget_id": "text",
  "tags": [
    "text"
  ],
  "enforced_params": [
    "text"
  ],
  "key_name": "text",
  "expires": "2025-01-29T20:19:26.683Z",
  "token_id": "text",
  "token": "text"
}

PreviousKey NextUpdate

Generate Key Fn

Generate an API key based on the provided data.

Docs: https://docs.litellm.ai/docs/proxy/virtual_keys

Parameters:

duration: Optional[str] - Specify the length of time the token is valid for. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d").
key_alias: Optional[str] - User defined key alias
key: Optional[str] - User defined key value. If not set, a 16-digit unique sk-key is created for you.
team_id: Optional[str] - The team id of the key
user_id: Optional[str] - The user id of the key
budget_id: Optional[str] - The budget id associated with the key. Created by calling /budget/new.
models: Optional[list] - Model_name's a user is allowed to call. (if empty, key is allowed to call all models)
aliases: Optional[dict] - Any alias mappings, on top of anything in the config.yaml model list. - https://docs.litellm.ai/docs/proxy/virtual_keys#managing-auth---upgradedowngrade-models
config: Optional[dict] - any key-specific configs, overrides config in config.yaml
spend: Optional[int] - Amount spent by key. Default is 0. Will be updated by proxy whenever key is used. https://docs.litellm.ai/docs/proxy/virtual_keys#managing-auth---tracking-spend
send_invite_email: Optional[bool] - Whether to send an invite email to the user_id, with the generate key
max_budget: Optional[float] - Specify max budget for a given key.
budget_duration: Optional[str] - Budget is reset at the end of specified duration. If not set, budget is never reset. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d").
max_parallel_requests: Optional[int] - Rate limit a user based on the number of parallel requests. Raises 429 error, if user's parallel requests > x.
metadata: Optional[dict] - Metadata for key, store information for key. Example metadata = {"team": "core-infra", "app": "app2", "email": "ishaan@berri.ai" }
guardrails: Optional[List[str]] - List of active guardrails for the key
permissions: Optional[dict] - key-specific permissions. Currently just used for turning off pii masking (if connected). Example - {"pii": false}
model_max_budget: Optional[Dict[str, BudgetConfig]] - Model-specific budgets {"gpt-4": {"budget_limit": 0.0005, "time_period": "30d"}}}. IF null or {} then no model specific budget.
model_rpm_limit: Optional[dict] - key-specific model rpm limit. Example - {"text-davinci-002": 1000, "gpt-3.5-turbo": 1000}. IF null or {} then no model specific rpm limit.
model_tpm_limit: Optional[dict] - key-specific model tpm limit. Example - {"text-davinci-002": 1000, "gpt-3.5-turbo": 1000}. IF null or {} then no model specific tpm limit.
allowed_cache_controls: Optional[list] - List of allowed cache control values. Example - ["no-cache", "no-store"]. See all values - https://docs.litellm.ai/docs/proxy/caching#turn-on--off-caching-per-request
blocked: Optional[bool] - Whether the key is blocked.
rpm_limit: Optional[int] - Specify rpm limit for a given key (Requests per minute)
tpm_limit: Optional[int] - Specify tpm limit for a given key (Tokens per minute)
soft_budget: Optional[float] - Specify soft budget for a given key. Will trigger a slack alert when this soft budget is reached.
tags: Optional[List[str]] - Tags for tracking spend and/or doing tag-based routing.
enforced_params: Optional[List[str]] - List of enforced params for the key (Enterprise only). Docs

Examples:

Allow users to turn on/off pii masking

curl --location 'http://0.0.0.0:4000/key/generate'         --header 'Authorization: Bearer sk-1234'         --header 'Content-Type: application/json'         --data '{
        "permissions": {"allow_pii_controls": true}
}'

Returns:

key: (str) The generated api key
expires: (datetime) Datetime object for when key expires.
user_id: (str) Unique user id - used for tracking spend across multiple keys for same user id.

POST/key/generate

const response = await fetch('/key/generate', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();

{ "key_alias": "text", "duration": "text", "models": [], "spend": 0, "max_budget": 0, "user_id": "text", "team_id": "text", "max_parallel_requests": 0, "tpm_limit": 0, "rpm_limit": 0, "budget_duration": "text", "allowed_cache_controls": [], "guardrails": [ "text" ], "blocked": false, "key": "text", "budget_id": "text", "tags": [ "text" ], "enforced_params": [ "text" ], "key_name": "text", "expires": "2025-01-29T20:19:26.683Z", "token_id": "text", "token": "text" }