Skip to content

_async

ImageGenerateAsyncResponse

Bases: HordeResponseBaseModel, JobResponseMixin, ResponseRequiringFollowUpMixin, ContainsMessageResponseMixin

Represents the data returned from the /v2/generate/async endpoint.

v2 API Model: RequestAsync

Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
class ImageGenerateAsyncResponse(
    HordeResponseBaseModel,
    JobResponseMixin,
    ResponseRequiringFollowUpMixin,
    ContainsMessageResponseMixin,
):
    """Represents the data returned from the `/v2/generate/async` endpoint.

    v2 API Model: `RequestAsync`
    """

    """The UUID for this image generation."""
    kudos: float
    """The expected kudos consumption for this request."""
    warnings: list[SingleWarningEntry] | None = None
    """Any warnings that were generated by the server or a serving worker."""

    @model_validator(mode="after")
    def validate_warnings(self) -> ImageGenerateAsyncResponse:
        if self.warnings is None:
            return self

        for warning in self.warnings:
            logger.warning(f"Warning from server ({warning.code}): {warning.message}")

        return self

    @override
    def get_follow_up_returned_params(self, *, as_python_field_name: bool = False) -> list[dict[str, object]]:
        if as_python_field_name:
            return [{"id_": self.id_}]
        return [{"id": self.id_}]

    @classmethod
    def get_follow_up_default_request_type(cls) -> type[ImageGenerateCheckRequest]:
        return ImageGenerateCheckRequest

    @override
    @classmethod
    def get_follow_up_request_types(  # type: ignore[override]
        cls,
    ) -> list[type[ImageGenerateCheckRequest | ImageGenerateStatusRequest]]:
        return [ImageGenerateCheckRequest, ImageGenerateStatusRequest]

    @override
    @classmethod
    def get_follow_up_failure_cleanup_request_type(cls) -> type[DeleteImageGenerateRequest]:
        return DeleteImageGenerateRequest

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "RequestAsync"

    def __hash__(self) -> int:
        return hash(ImageGenerateAsyncResponse.__name__) + hash(self.id_)

    def __eq__(self, __value: object) -> bool:
        return isinstance(__value, ImageGenerateAsyncResponse) and self.id_ == __value.id_

kudos instance-attribute 

kudos: float

The expected kudos consumption for this request.

warnings class-attribute instance-attribute 

warnings: list[SingleWarningEntry] | None = None

Any warnings that were generated by the server or a serving worker.

validate_warnings 

validate_warnings() -> ImageGenerateAsyncResponse
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
46
47
48
49
50
51
52
53
54
@model_validator(mode="after")
def validate_warnings(self) -> ImageGenerateAsyncResponse:
    if self.warnings is None:
        return self

    for warning in self.warnings:
        logger.warning(f"Warning from server ({warning.code}): {warning.message}")

    return self

get_follow_up_returned_params 

get_follow_up_returned_params(*, as_python_field_name: bool = False) -> list[dict[str, object]]
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
56
57
58
59
60
@override
def get_follow_up_returned_params(self, *, as_python_field_name: bool = False) -> list[dict[str, object]]:
    if as_python_field_name:
        return [{"id_": self.id_}]
    return [{"id": self.id_}]

get_follow_up_default_request_type classmethod 

get_follow_up_default_request_type() -> type[ImageGenerateCheckRequest]
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
62
63
64
@classmethod
def get_follow_up_default_request_type(cls) -> type[ImageGenerateCheckRequest]:
    return ImageGenerateCheckRequest

get_follow_up_request_types classmethod 

get_follow_up_request_types() -> list[type[ImageGenerateCheckRequest | ImageGenerateStatusRequest]]
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
66
67
68
69
70
71
@override
@classmethod
def get_follow_up_request_types(  # type: ignore[override]
    cls,
) -> list[type[ImageGenerateCheckRequest | ImageGenerateStatusRequest]]:
    return [ImageGenerateCheckRequest, ImageGenerateStatusRequest]

get_follow_up_failure_cleanup_request_type classmethod 

get_follow_up_failure_cleanup_request_type() -> type[DeleteImageGenerateRequest]
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
73
74
75
76
@override
@classmethod
def get_follow_up_failure_cleanup_request_type(cls) -> type[DeleteImageGenerateRequest]:
    return DeleteImageGenerateRequest

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
78
79
80
81
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "RequestAsync"

__hash__ 

__hash__() -> int
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
83
84
def __hash__(self) -> int:
    return hash(ImageGenerateAsyncResponse.__name__) + hash(self.id_)

__eq__ 

__eq__(__value: object) -> bool
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
86
87
def __eq__(self, __value: object) -> bool:
    return isinstance(__value, ImageGenerateAsyncResponse) and self.id_ == __value.id_

ImageGenerateAsyncDryRunResponse

Bases: HordeResponseBaseModel

Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
90
91
92
93
94
95
96
97
class ImageGenerateAsyncDryRunResponse(HordeResponseBaseModel):
    kudos: float
    """The expected kudos consumption for this request."""

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

kudos instance-attribute 

kudos: float

The expected kudos consumption for this request.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
94
95
96
97
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return _ANONYMOUS_MODEL

ImageGenerationInputPayload

Bases: ImageGenerateParamMixin

Represents the 'params' field in the /v2/generate/async endpoint.

v2 API Model: ModelGenerationInputStable

Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
class ImageGenerationInputPayload(ImageGenerateParamMixin):
    """Represents the 'params' field in the `/v2/generate/async` endpoint.

    v2 API Model: `ModelGenerationInputStable`
    """

    steps: int = Field(default=25, ge=1, validation_alias=AliasChoices("steps", "ddim_steps"))
    """The number of image generation steps to perform."""

    n: int = Field(default=1, ge=1, le=20, validation_alias=AliasChoices("n", "n_iter"))
    """The number of images to generate. Defaults to 1, maximum is 20."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "ModelGenerationInputStable"

    @field_validator("n", mode="before")
    def validate_n(cls, value: int) -> int:
        if value == 0:
            logger.debug("n (number of images to generate) is not set; defaulting to 1")
            return 1

        return value

steps class-attribute instance-attribute 

steps: int = Field(default=25, ge=1, validation_alias=AliasChoices('steps', 'ddim_steps'))

The number of image generation steps to perform.

n class-attribute instance-attribute 

n: int = Field(default=1, ge=1, le=20, validation_alias=AliasChoices('n', 'n_iter'))

The number of images to generate. Defaults to 1, maximum is 20.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
112
113
114
115
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "ModelGenerationInputStable"

validate_n 

validate_n(value: int) -> int
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
117
118
119
120
121
122
123
@field_validator("n", mode="before")
def validate_n(cls, value: int) -> int:
    if value == 0:
        logger.debug("n (number of images to generate) is not set; defaulting to 1")
        return 1

    return value

ImageGenerateAsyncRequest

Bases: BaseAIHordeRequest, APIKeyAllowedInRequestMixin, RequestUsesWorkerMixin

Represents the data needed to make a request to the /v2/generate/async endpoint.

v2 API Model: GenerationInputStable

Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
class ImageGenerateAsyncRequest(
    BaseAIHordeRequest,
    APIKeyAllowedInRequestMixin,
    RequestUsesWorkerMixin,
):
    """Represents the data needed to make a request to the `/v2/generate/async` endpoint.

    v2 API Model: `GenerationInputStable`
    """

    prompt: str
    """The prompt which will be sent to Stable Diffusion to generate an image."""

    params: ImageGenerationInputPayload | None = None
    """The parameters for the image generation."""

    nsfw: bool | None = True
    """Set to true if this request is NSFW. This will skip workers which censor images."""
    censor_nsfw: bool = False
    """If the request is SFW, and the worker accidentally generates NSFW, it will send back a censored image."""

    r2: bool = True
    """If True, the image will be sent via cloudflare r2 download link."""

    shared: bool = False
    """If True, The image will be shared with LAION for improving their dataset. This will also reduce your
    kudos consumption by 2. For anonymous users, this is always True."""

    replacement_filter: bool = True
    """If enabled, suspicious prompts are sanitized through a string replacement filter instead."""

    source_image: str | None = None
    """The public URL of the source image or a base64 string to use."""
    source_processing: KNOWN_SOURCE_PROCESSING = KNOWN_SOURCE_PROCESSING.txt2img
    """If source_image is provided, specifies how to process it."""
    source_mask: str | None = None
    """If source_processing is set to 'inpainting' or 'outpainting', this parameter can be optionally provided as the
    Base64-encoded webp mask of the areas to inpaint. If this arg is not passed, the inpainting/outpainting mask has to
    be embedded as alpha channel."""
    extra_source_images: list[ExtraSourceImageEntry] | None = None
    """Additional uploaded images which can be used for further operations."""

    @model_validator(mode="after")
    def validate_censor_nsfw(self) -> ImageGenerateAsyncRequest:
        if self.nsfw and self.censor_nsfw:
            raise ValueError("Cannot censor NSFW content when NSFW detection is enabled.")
        return self

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "GenerationInputStable"

    @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_generate_async

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

    @override
    @classmethod
    def get_success_status_response_pairs(cls) -> dict[HTTPStatusCode, type[HordeResponseTypes]]:
        return {
            HTTPStatusCode.OK: ImageGenerateAsyncDryRunResponse,
            HTTPStatusCode.ACCEPTED: cls.get_default_success_response_type(),
        }

    @override
    def get_number_of_results_expected(self) -> int:
        if not self.params:
            return 1
        return self.params.n

    @override
    def get_extra_fields_to_exclude_from_log(self) -> set[str]:
        return {"source_image", "source_mask", "extra_source_images"}

prompt instance-attribute 

prompt: str

The prompt which will be sent to Stable Diffusion to generate an image.

params class-attribute instance-attribute 

params: ImageGenerationInputPayload | None = None

The parameters for the image generation.

nsfw class-attribute instance-attribute 

nsfw: bool | None = True

Set to true if this request is NSFW. This will skip workers which censor images.

censor_nsfw class-attribute instance-attribute 

censor_nsfw: bool = False

If the request is SFW, and the worker accidentally generates NSFW, it will send back a censored image.

r2 class-attribute instance-attribute 

r2: bool = True

If True, the image will be sent via cloudflare r2 download link.

shared class-attribute instance-attribute 

shared: bool = False

If True, The image will be shared with LAION for improving their dataset. This will also reduce your kudos consumption by 2. For anonymous users, this is always True.

replacement_filter class-attribute instance-attribute 

replacement_filter: bool = True

If enabled, suspicious prompts are sanitized through a string replacement filter instead.

source_image class-attribute instance-attribute 

source_image: str | None = None

The public URL of the source image or a base64 string to use.

source_processing class-attribute instance-attribute 

source_processing: KNOWN_SOURCE_PROCESSING = txt2img

If source_image is provided, specifies how to process it.

source_mask class-attribute instance-attribute 

source_mask: str | None = None

If source_processing is set to 'inpainting' or 'outpainting', this parameter can be optionally provided as the Base64-encoded webp mask of the areas to inpaint. If this arg is not passed, the inpainting/outpainting mask has to be embedded as alpha channel.

extra_source_images class-attribute instance-attribute 

extra_source_images: list[ExtraSourceImageEntry] | None = None

Additional uploaded images which can be used for further operations.

validate_censor_nsfw 

validate_censor_nsfw() -> ImageGenerateAsyncRequest
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
168
169
170
171
172
@model_validator(mode="after")
def validate_censor_nsfw(self) -> ImageGenerateAsyncRequest:
    if self.nsfw and self.censor_nsfw:
        raise ValueError("Cannot censor NSFW content when NSFW detection is enabled.")
    return self

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
174
175
176
177
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "GenerationInputStable"

get_http_method classmethod 

get_http_method() -> HTTPMethod
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
179
180
181
182
@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/generate/_async.py 
184
185
186
187
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_generate_async

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[ImageGenerateAsyncResponse]
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
189
190
191
192
@override
@classmethod
def get_default_success_response_type(cls) -> type[ImageGenerateAsyncResponse]:
    return ImageGenerateAsyncResponse

get_success_status_response_pairs classmethod 

get_success_status_response_pairs() -> dict[HTTPStatusCode, type[HordeResponseTypes]]
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
194
195
196
197
198
199
200
@override
@classmethod
def get_success_status_response_pairs(cls) -> dict[HTTPStatusCode, type[HordeResponseTypes]]:
    return {
        HTTPStatusCode.OK: ImageGenerateAsyncDryRunResponse,
        HTTPStatusCode.ACCEPTED: cls.get_default_success_response_type(),
    }

get_number_of_results_expected 

get_number_of_results_expected() -> int
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
202
203
204
205
206
@override
def get_number_of_results_expected(self) -> int:
    if not self.params:
        return 1
    return self.params.n

get_extra_fields_to_exclude_from_log 

get_extra_fields_to_exclude_from_log() -> set[str]
Source code in horde_sdk/ai_horde_api/apimodels/generate/_async.py 
208
209
210
@override
def get_extra_fields_to_exclude_from_log(self) -> set[str]:
    return {"source_image", "source_mask", "extra_source_images"}