New

New User

Use this to create a new INTERNAL user with a budget. Internal Users can access LiteLLM Admin UI to make keys, request access to models. This creates a new user and generates a new api key for the new user. The new api key is returned.

Returns user id, budget + new key.

Parameters:

• user_id: Optional[str] - Specify a user id. If not set, a unique id will be generated.
• user_alias: Optional[str] - A descriptive name for you to know who this user id refers to.
• teams: Optional[list] - specify a list of team id's a user belongs to.
• user_email: Optional[str] - Specify a user email.
• send_invite_email: Optional[bool] - Specify if an invite email should be sent.
• user_role: Optional[str] - Specify a user role - "proxy_admin", "proxy_admin_viewer", "internal_user", "internal_user_viewer", "team", "customer". Info about each role here: https://github.com/BerriAI/litellm/litellm/proxy/_types.py#L20
• max_budget: Optional[float] - Specify max budget for a given user.
• 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"), months ("1mo").
• models: Optional[list] - Model_name's a user is allowed to call. (if empty, key is allowed to call all models)
• tpm_limit: Optional[int] - Specify tpm limit for a given user (Tokens per minute)
• rpm_limit: Optional[int] - Specify rpm limit for a given user (Requests per minute)
• auto_create_key: bool - Default=True. Flag used for returning a key as part of the /user/new response
• aliases: Optional[dict] - Model aliases for the user - Docs
• config: Optional[dict] - [DEPRECATED PARAM] User-specific config.
• 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] - [Not Implemented Yet] Whether the user is blocked.
• guardrails: Optional[List[str]] - [Not Implemented Yet] List of active guardrails for the user
• permissions: Optional[dict] - [Not Implemented Yet] User-specific permissions, eg. turning off pii masking.
• metadata: Optional[dict] - Metadata for user, store information for user. Example metadata = {"team": "core-infra", "app": "app2", "email": "[e-mail]" }
• 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.
• soft_budget: Optional[float] - Get alerts when user crosses given budget, doesn't block requests.
• model_max_budget: Optional[dict] - Model-specific max budget for user. Docs
• model_rpm_limit: Optional[float] - Model-specific rpm limit for user. Docs
• model_tpm_limit: Optional[float] - Model-specific tpm limit for user. Docs
• spend: Optional[float] - Amount spent by user. Default is 0. Will be updated by proxy whenever user is used. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d"), months ("1mo").
• team_id: Optional[str] - [DEPRECATED PARAM] The team id of the user. Default is None.
• duration: Optional[str] - Duration for the key auto-created on /user/new. Default is None.
• key_alias: Optional[str] - Alias for the key auto-created on /user/new. Default is None.

Returns:

• key: (str) The generated api key for the user
• 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.
• max_budget: (float|None) Max budget for given user.

Usage Example

 curl -X POST "http://localhost:4000/user/new"      -H "Content-Type: application/json"      -H "Authorization: Bearer sk-1234"      -d '{
     "username": "new_user",
     "email": "[e-mail]"
 }'

POST/user/new

Authorization

APIKeyHeaderAPIKeyHeaderAPIKeyHeaderAPIKeyHeader

Body

application/json

key_aliasKey Alias

stringnull

durationDuration

stringnull

modelsModels

array of anynull

spendSpend

numbernull

max_budgetMax Budget

numbernull

user_idUser Id

stringnull

team_idTeam Id

stringnull

max_parallel_requestsMax Parallel Requests

integernull

metadataMetadata

objectnull

tpm_limitTpm Limit

integernull

rpm_limitRpm Limit

integernull

budget_durationBudget Duration

stringnull

allowed_cache_controlsAllowed Cache Controls

array of anynull

configConfig

objectnull

permissionsPermissions

objectnull

model_max_budgetModel Max Budget

objectnull

model_rpm_limitModel Rpm Limit

objectnull

model_tpm_limitModel Tpm Limit

objectnull

guardrailsGuardrails

array of stringnull

blockedBlocked

booleannull

aliasesAliases

objectnull

user_emailUser Email

stringnull

user_aliasUser Alias

stringnull

user_roleUser Role

enumnull

teamsTeams

array of anynull

auto_create_keyAuto Create Key

send_invite_emailSend Invite Email

booleannull

Response

200422

Successful Response

Body

application/json

key_aliasKey Alias

stringnull

durationDuration

stringnull

modelsModels

array of anynull

spendSpend

numbernull

max_budgetMax Budget

numbernull

user_idUser Id

stringnull

team_idTeam Id

stringnull

max_parallel_requestsMax Parallel Requests

integernull

metadataMetadata

objectnull

tpm_limitTpm Limit

integernull

rpm_limitRpm Limit

integernull

budget_durationBudget Duration

stringnull

allowed_cache_controlsAllowed Cache Controls

array of anynull

configConfig

objectnull

permissionsPermissions

objectnull

model_max_budgetModel Max Budget

objectnull

model_rpm_limitModel Rpm Limit

objectnull

model_tpm_limitModel Tpm Limit

objectnull

guardrailsGuardrails

array of stringnull

blockedBlocked

booleannull

aliasesAliases

objectnull

key*Key

budget_idBudget Id

stringnull

tagsTags

array of stringnull

enforced_paramsEnforced Params

array of stringnull

key_nameKey Name

stringnull

expires*Expires

string (date-time)null

token_idToken Id

stringnull

litellm_budget_tableLitellm Budget Table

anynull

tokenToken

stringnull

user_emailUser Email

stringnull

user_roleUser Role

enumnull

teamsTeams

array of anynull

user_aliasUser Alias

stringnull

Request

JavaScriptCurlPythonHTTP

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

Response

200422

{
  "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:21.594Z",
  "token_id": "text",
  "token": "text",
  "user_email": "text",
  "user_role": "proxy_admin",
  "teams": [],
  "user_alias": "text"
}