models

Request and response models for the v2 API.

ModelRecordUnion module-attribute

ModelRecordUnion = Annotated[
    ImageGenerationModelRecord
    | TextGenerationModelRecord
    | ControlNetModelRecord
    | BlipModelRecord
    | ClipModelRecord
    | CodeformerModelRecord
    | EsrganModelRecord
    | GfpganModelRecord
    | SafetyCheckerModelRecord
    | VideoGenerationModelRecord
    | AudioGenerationModelRecord
    | MiscellaneousModelRecord
    | GenericModelRecord,
    Field(
        description="A model record conforming to one of the category-specific schemas"
    ),
]

Union of all possible model record types for OpenAPI documentation.

ModelRecordUnionType module-attribute

ModelRecordUnionType = (
    ImageGenerationModelRecord
    | TextGenerationModelRecord
    | ControlNetModelRecord
    | BlipModelRecord
    | ClipModelRecord
    | CodeformerModelRecord
    | EsrganModelRecord
    | GfpganModelRecord
    | SafetyCheckerModelRecord
    | VideoGenerationModelRecord
    | AudioGenerationModelRecord
    | MiscellaneousModelRecord
    | GenericModelRecord
)

Union of all possible model record types for type hints.

UserRolesResponse

Bases: BaseModel

Response model for the user roles endpoint.

Source code in src/horde_model_reference/service/v2/models.py

class UserRolesResponse(BaseModel):
    """Response model for the user roles endpoint."""

    user_id: str
    """The unique Horde user ID (e.g., '6572')."""

    username: str
    """The full Horde username including discriminator (e.g., 'Tazlin#6572')."""

    roles: list[str]
    """List of roles assigned to the user (e.g., ['approver', 'requestor'])."""

    is_approver: bool
    """Whether the user has approver privileges for the pending queue."""

    is_requestor: bool
    """Whether the user has requestor privileges for the pending queue."""

user_id instance-attribute

user_id: str

The unique Horde user ID (e.g., '6572').

username instance-attribute

username: str

The full Horde username including discriminator (e.g., 'Tazlin#6572').

roles instance-attribute

roles: list[str]

List of roles assigned to the user (e.g., ['approver', 'requestor']).

is_approver instance-attribute

is_approver: bool

Whether the user has approver privileges for the pending queue.

is_requestor instance-attribute

is_requestor: bool

Whether the user has requestor privileges for the pending queue.