New User

post https://api.hanzo.ai/user/new

Use this to create a new INTERNAL user with a budget.
Internal Users can access LLM 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/hanzoai/llm/llm/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). Set to ['no-default-models'] to block all model access. Restricting user to only team-based model access.
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://hanzo.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": "[email protected]" }
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": "[email protected]"
 }'