Skip to content

_kudos

KudosTransferResponse

Bases: HordeResponseBaseModel

Source code in horde_sdk/ai_horde_api/apimodels/_kudos.py 
 9
10
11
12
13
14
15
16
class KudosTransferResponse(HordeResponseBaseModel):
    transferred: float | None = None
    """The amount of Kudos transferred."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str:
        return "KudosTransferred"

transferred class-attribute instance-attribute 

transferred: float | None = None

The amount of Kudos transferred.

get_api_model_name classmethod 

get_api_model_name() -> str
Source code in horde_sdk/ai_horde_api/apimodels/_kudos.py 
13
14
15
16
@override
@classmethod
def get_api_model_name(cls) -> str:
    return "KudosTransferred"

KudosTransferRequest

Bases: BaseAIHordeRequest, APIKeyAllowedInRequestMixin

Source code in horde_sdk/ai_horde_api/apimodels/_kudos.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
class KudosTransferRequest(
    BaseAIHordeRequest,
    APIKeyAllowedInRequestMixin,
):
    username: str
    """The username of the user to transfer Kudos to."""
    amount: float
    """The amount of Kudos to transfer."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str:
        return _ANONYMOUS_MODEL

    @override
    @classmethod
    def get_http_method(cls) -> HTTPMethod:
        return HTTPMethod.POST

    @override
    @classmethod
    def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_kudos_transfer

    @override
    @classmethod
    def get_default_success_response_type(cls) -> type[KudosTransferResponse]:
        return KudosTransferResponse

    @override
    @classmethod
    def is_api_key_required(cls) -> bool:
        return True

username instance-attribute 

username: str

The username of the user to transfer Kudos to.

amount instance-attribute 

amount: float

The amount of Kudos to transfer.

get_api_model_name classmethod 

get_api_model_name() -> str
Source code in horde_sdk/ai_horde_api/apimodels/_kudos.py 
28
29
30
31
@override
@classmethod
def get_api_model_name(cls) -> str:
    return _ANONYMOUS_MODEL

get_http_method classmethod 

get_http_method() -> HTTPMethod
Source code in horde_sdk/ai_horde_api/apimodels/_kudos.py 
33
34
35
36
@override
@classmethod
def get_http_method(cls) -> HTTPMethod:
    return HTTPMethod.POST

get_api_endpoint_subpath classmethod 

get_api_endpoint_subpath() -> AI_HORDE_API_ENDPOINT_SUBPATH
Source code in horde_sdk/ai_horde_api/apimodels/_kudos.py 
38
39
40
41
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_kudos_transfer

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[KudosTransferResponse]
Source code in horde_sdk/ai_horde_api/apimodels/_kudos.py 
43
44
45
46
@override
@classmethod
def get_default_success_response_type(cls) -> type[KudosTransferResponse]:
    return KudosTransferResponse

is_api_key_required classmethod 

is_api_key_required() -> bool
Source code in horde_sdk/ai_horde_api/apimodels/_kudos.py 
48
49
50
51
@override
@classmethod
def is_api_key_required(cls) -> bool:
    return True