Local UI to run and train LLMs and diffusion models. Supports GGUF, MLX, Qwen3.8, DeepSeek-V4.1, MiniMax-H3, Gemma 4, FLUX and more.
Python agentaichatgptdeepseekfine-tuninggemmaimage-generationllamallmllmsopenaipythonqwenreinforcement-learningself-hostedstable-diffusiontext-to-speechttsuiunsloth
# SPDX-License-Identifier: AGPL-3.0-only
# Copyright 2026-present the Unsloth AI Inc. team. All rights reserved. See /studio/LICENSE.AGPL-3.0
"""Pydantic schemas for the Authentication API."""
from typing import Optional
from pydantic import BaseModel, Field, field_validator
from auth.storage import (
MIN_PASSWORD_LENGTH,
normalize_model_allowlist,
validate_account_username,
)
class AuthLoginRequest(BaseModel):
"""Login payload: username/password to obtain a JWT."""
username: str = Field(..., description = "Username")
password: str = Field(..., description = "Password")
class DesktopLoginRequest(BaseModel):
"""Desktop-only local secret exchange payload."""
secret: str = Field(..., description = "Desktop local auth secret")
class RefreshTokenRequest(BaseModel):
"""Refresh token payload to obtain new access + refresh tokens."""
refresh_token: str = Field(..., description = "Refresh token from a previous login or refresh")
class AuthStatusResponse(BaseModel):
"""Indicate whether the seeded admin auth flow is ready."""
initialized: bool = Field(..., description = "True if the auth database contains a login user")
default_username: str = Field(
"unsloth",
description = "Default admin username for first-boot UI prefill.",
)
login_mode: str = Field(
"single",
description = (
"'single' when one account exists, so the form posts default_username without asking; "
"'multi' when a username has to be entered. Never lists accounts."
),
)
full_access: bool = Field(
True,
description = (
"Legacy pre-login hint: false whenever another account exists, active or not. "
"Signed-in clients offer Full access only to the installation owner."
),
)
requires_password_change: bool = Field(
...,
description = "True if the seeded admin must still change the default password",
)
bootstrap_deadline_seconds: Optional[int] = Field(
None,
description = (
"Seconds until this instance shuts down for leaving the default password "
"unchanged, or null when the launch is not time-boxed."
),
)
class DesktopInitialPasswordRequest(BaseModel):
"""Set the seeded admin's first real password from the desktop app."""
new_password: str = Field(
...,
min_length = MIN_PASSWORD_LENGTH,
description = f"Replacement password (minimum {MIN_PASSWORD_LENGTH} characters)",
)
class ChangePasswordRequest(BaseModel):
"""Change the current user's password, typically on first login."""
current_password: str = Field(
...,
min_length = MIN_PASSWORD_LENGTH,
description = "Existing password for the authenticated user",
)
new_password: str = Field(
...,
min_length = MIN_PASSWORD_LENGTH,
description = f"Replacement password (minimum {MIN_PASSWORD_LENGTH} characters)",
)
class CreateApiKeyRequest(BaseModel):
"""Request body to create a new API key."""
name: str = Field(..., description = "Human-readable label for this key")
expires_in_days: Optional[int] = Field(
None,
ge = 1,
le = 36500,
description = "Number of days until the key expires (None = never)",
)
class ApiKeyResponse(BaseModel):
"""Public representation of an API key (never contains the raw key)."""
id: int
name: str
key_prefix: str = Field(..., description = "First 8 characters after sk-unsloth- for display")
created_at: str
last_used_at: Optional[str] = None
expires_at: Optional[str] = None
is_active: bool
# Read-only: set by the server at mint ("unsloth_start" for the desktop `unsloth start` key).
purpose: Optional[str] = None
class CreateApiKeyResponse(BaseModel):
"""Returned once when a key is created -- ``key`` is never shown again."""
key: str = Field(..., description = "Full API key (shown once)")
api_key: ApiKeyResponse
class ApiKeyListResponse(BaseModel):
"""List of API keys for the authenticated user."""
api_keys: list[ApiKeyResponse]
class CreateAccountRequest(BaseModel):
username: str
@field_validator("username")
@classmethod
def validate_username(cls, value: str) -> str:
return validate_account_username(value)
class AccountActiveRequest(BaseModel):
is_active: bool
class AccountModelAccessRequest(BaseModel):
model_allowlist: Optional[list[str]] = Field(
None,
description = "Hugging Face repo ids or org/* patterns; null or empty allows every model",
)
@field_validator("model_allowlist")
@classmethod
def validate_model_allowlist(cls, value: Optional[list[str]]) -> Optional[list[str]]:
return normalize_model_allowlist(value)
class AccountResponse(BaseModel):
account_id: str
username: str
role: str
is_active: bool
created_at: str
setup_code_pending: bool
model_allowlist: Optional[list[str]] = None
login_alias: Optional[str] = None
display_name: Optional[str] = None
avatar_url: Optional[str] = None
class OwnerLoginAliasRequest(BaseModel):
login_alias: Optional[str] = Field(
None, description = 'Owner sign-in name; null, empty or "unsloth" clears it'
)
class AccountListResponse(BaseModel):
accounts: list[AccountResponse]
class AccountSetupResponse(BaseModel):
account: AccountResponse
setup_code: str
setup_code_expires_at: str