docs(proxy_server.py): improve swagger docs for /team/new

This commit is contained in:
Krrish Dholakia 2024-03-28 15:50:38 -07:00
parent a1d0e3f4ad
commit 569e660a67

View file

@ -5671,16 +5671,18 @@ async def new_team(
"""
Allow users to create a new team. Apply user permissions to their team.
[ASK FOR HELP](https://github.com/BerriAI/litellm/issues)
Parameters:
- team_alias: Optional[str] - User defined team alias
- team_id: Optional[str] - The team id of the user. If none passed, we'll generate it.
- members_with_roles: List[Member] - A list of members with their roles in the team
- members_with_roles: List[{"role": "admin" or "user", "user_id": "<user-id>"}] - A list of users and their roles in the team. Get user_id when making a new user via `/user/new`.
- metadata: Optional[dict] - Metadata for team, store information for team. Example metadata = {"team": "core-infra", "app": "app2", "email": "ishaan@berri.ai" }
- tpm_limit: Optional[int] - The limit for TPM (Transactions Per Minute)
- rpm_limit: Optional[int] - The limit for RPM (Requests Per Minute)
- max_budget: Optional[float] - The maximum budget allocated to the team
- models: list - A list of models associated with the team
- blocked: bool - Flag indicating if the team is blocked or not
- tpm_limit: Optional[int] - The TPM (Tokens Per Minute) limit for this team - all keys with this team_id will have at max this TPM limit
- rpm_limit: Optional[int] - The RPM (Requests Per Minute) limit for this team - all keys associated with this team_id will have at max this RPM limit
- max_budget: Optional[float] - The maximum budget allocated to the team - all keys for this team_id will have at max this max_budget
- models: Optional[list] - A list of models associated with the team - all keys for this team_id will have at most, these models. If empty, assumes all models are allowed.
- blocked: bool - Flag indicating if the team is blocked or not - will stop all calls from keys with this team_id.
Returns:
- team_id: (str) Unique team id - used for tracking spend across multiple keys for same team id.