Skip to main content

🔑 [BETA] Proxy UI

Create + delete keys through a UI​

Let users create their own keys

info

This is in beta, so things may change. If you have feedback, let us know

Quick Start​

  • Requires proxy master key to be set
  • Requires db connected

Follow setup

1. Start the proxy​

litellm --config /path/to/config.yaml

#INFO: Proxy running on http://0.0.0.0:8000

2. Go to UI​

http://0.0.0.0:8000/ui # <proxy_base_url>/ui

Your Proxy Swagger is available on the root of the Proxy: e.g.: http://localhost:4000/

Change default username + password​

Set the following in your .env on the Proxy

UI_USERNAME=ishaan-litellm
UI_PASSWORD=langchain

On accessing the LiteLLM UI, you will be prompted to enter your username, password

Setup SSO/Auth for UI​

Step 1: Set upperbounds for keys​

Control the upperbound that users can use for max_budget, budget_duration or any key/generate param per key. 

litellm_settings:
  upperbound_key_generate_params:
    max_budget: 100 # upperbound of $100, for all /key/generate requests
    duration: "30d" # upperbound of 30 days for all /key/generate requests

Expected Behavior

  • Send a /key/generate request with max_budget=200
  • Key will be created with max_budget=100 since 100 is the upper bound

Step 2: Setup Oauth Client​

Required .env variables on your Proxy

# for Google SSO Login
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
  • Set Redirect URL on your Oauth 2.0 Client on https://console.cloud.google.com/
    • Set a redirect url = <your proxy base url>/sso/callback
      https://litellm-production-7002.up.railway.app/sso/callback

Step 3. Test flow​

Set Admin view w/ SSO​

You just need to set Proxy Admin ID

Step 1: Copy your ID from the UI​

Step 2: Set it in your .env as the PROXY_ADMIN_ID​

export PROXY_ADMIN_ID="116544810872468347480"

Step 3: See all proxy keys​

info

If you don't see all your keys this could be due to a cached token. So just re-login and it should work.