From b437260ece8f7b7d992a073583ed2d728507caa3 Mon Sep 17 00:00:00 2001
From: Krrish Dholakia <krrishdholakia@gmail.com>
Date: Wed, 27 Dec 2023 20:30:20 +0530
Subject: [PATCH] docs(users.md): set budgets per user docs

---
 docs/my-website/docs/proxy/users.md | 30 +++++++++++++++++++++++++++++
 docs/my-website/sidebars.js         |  1 +
 2 files changed, 31 insertions(+)
 create mode 100644 docs/my-website/docs/proxy/users.md

diff --git a/docs/my-website/docs/proxy/users.md b/docs/my-website/docs/proxy/users.md
new file mode 100644
index 000000000..2b06daa6f
--- /dev/null
+++ b/docs/my-website/docs/proxy/users.md
@@ -0,0 +1,30 @@
+# Set budgets per user 
+
+LiteLLM exposes a `/user/new` endpoint to create budgets for users, that persist across multiple keys. 
+
+Requirements: 
+
+- Need to a postgres database (e.g. [Supabase](https://supabase.com/), [Neon](https://neon.tech/), etc)
+
+This is documented in the swagger (live on your server root endpoint - e.g. `http://0.0.0.0:8000/`). Here's an example request. 
+
+```curl 
+curl --location 'http://localhost:8000/user/new' \
+--header 'Authorization: Bearer <your-master-key>' \
+--header 'Content-Type: application/json' \
+--data-raw '{"models": ["azure-models"], "max_budget": 0, "user_id": "krrish3@berri.ai"}' 
+```
+The request is a normal `/key/generate` request body + a `max_budget` field. 
+
+**Sample Response**
+
+```curl
+{
+    "key": "sk-YF2OxDbrgd1y2KgwxmEA2w",
+    "expires": "2023-12-22T09:53:13.861000Z",
+    "user_id": "krrish3@berri.ai",
+    "max_budget": 0.0
+}
+```
+
+
diff --git a/docs/my-website/sidebars.js b/docs/my-website/sidebars.js
index 44f1ad2dc..3a1caa048 100644
--- a/docs/my-website/sidebars.js
+++ b/docs/my-website/sidebars.js
@@ -104,6 +104,7 @@ const sidebars = {
         "proxy/load_balancing", 
         "proxy/virtual_keys",
         "proxy/user_keys",
+        "proxy/users",
         "proxy/model_management",
         "proxy/reliability",
         "proxy/health",