Skip to content

base

The base classes for all AI Horde API requests/responses.

BaseAIHordeRequest

Bases: HordeRequest

Base class for all AI Horde API requests.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
37
38
39
40
41
42
43
class BaseAIHordeRequest(HordeRequest):
    """Base class for all AI Horde API requests."""

    @override
    @classmethod
    def get_api_url(cls) -> str:
        return AI_HORDE_BASE_URL

get_api_url classmethod 

get_api_url() -> str
Source code in horde_sdk/ai_horde_api/apimodels/base.py 
40
41
42
43
@override
@classmethod
def get_api_url(cls) -> str:
    return AI_HORDE_BASE_URL

JobRequestMixin

Bases: HordeAPIData

Mix-in class for data relating to any generation jobs.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
class JobRequestMixin(HordeAPIData):
    """Mix-in class for data relating to any generation jobs."""

    id_: JobID = Field(alias="id")
    """The UUID for this job. Use this to post the results in the future."""

    @field_validator("id_", mode="before")
    def validate_id(cls, v: str | JobID) -> JobID | str:
        """Ensure that the job ID is not empty."""
        if isinstance(v, str) and v == "":
            logger.warning("Job ID is empty")
            return JobID(root=uuid.uuid4())

        return v

    def __eq__(self, __value: object) -> bool:
        if isinstance(__value, JobRequestMixin):
            return self.id_ == __value.id_
        return False

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

id_ class-attribute instance-attribute 

id_: JobID = Field(alias='id')

The UUID for this job. Use this to post the results in the future.

validate_id 

validate_id(v: str | JobID) -> JobID | str

Ensure that the job ID is not empty.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
52
53
54
55
56
57
58
59
@field_validator("id_", mode="before")
def validate_id(cls, v: str | JobID) -> JobID | str:
    """Ensure that the job ID is not empty."""
    if isinstance(v, str) and v == "":
        logger.warning("Job ID is empty")
        return JobID(root=uuid.uuid4())

    return v

__eq__ 

__eq__(__value: object) -> bool
Source code in horde_sdk/ai_horde_api/apimodels/base.py 
61
62
63
64
def __eq__(self, __value: object) -> bool:
    if isinstance(__value, JobRequestMixin):
        return self.id_ == __value.id_
    return False

__hash__ 

__hash__() -> int
Source code in horde_sdk/ai_horde_api/apimodels/base.py 
66
67
def __hash__(self) -> int:
    return hash(JobRequestMixin.__name__) + hash(self.id_)

JobResponseMixin

Bases: HordeAPIData

Mix-in class for data relating to any generation jobs.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
class JobResponseMixin(HordeAPIData):
    """Mix-in class for data relating to any generation jobs."""

    id_: JobID = Field(alias="id")
    """The UUID for this job."""

    @field_validator("id_", mode="before")
    def validate_id(cls, v: str | JobID) -> JobID | str:
        """Ensure that the job ID is not empty."""
        if isinstance(v, str) and v == "":
            logger.warning("Job ID is empty")
            return JobID(root=uuid.uuid4())

        return v

id_ class-attribute instance-attribute 

id_: JobID = Field(alias='id')

The UUID for this job.

validate_id 

validate_id(v: str | JobID) -> JobID | str

Ensure that the job ID is not empty.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
76
77
78
79
80
81
82
83
@field_validator("id_", mode="before")
def validate_id(cls, v: str | JobID) -> JobID | str:
    """Ensure that the job ID is not empty."""
    if isinstance(v, str) and v == "":
        logger.warning("Job ID is empty")
        return JobID(root=uuid.uuid4())

    return v

WorkerRequestMixin

Bases: HordeAPIData

Mix-in class for data relating to worker requests.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
86
87
88
89
90
class WorkerRequestMixin(HordeAPIData):
    """Mix-in class for data relating to worker requests."""

    worker_id: str | WorkerID
    """The UUID of the worker in question for this request."""

worker_id instance-attribute 

worker_id: str | WorkerID

The UUID of the worker in question for this request.

WorkerRequestNameMixin

Bases: HordeAPIData

Mix-in class for data relating to worker requests.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
93
94
95
96
97
class WorkerRequestNameMixin(HordeAPIData):
    """Mix-in class for data relating to worker requests."""

    worker_name: str
    """The name of the worker in question for this request."""

worker_name instance-attribute 

worker_name: str

The name of the worker in question for this request.

LorasPayloadEntry

Bases: HordeAPIObjectBaseModel

Represents a single lora parameter.

v2 API Model: ModelPayloadLorasStable

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
class LorasPayloadEntry(HordeAPIObjectBaseModel):
    """Represents a single lora parameter.

    v2 API Model: `ModelPayloadLorasStable`
    """

    name: str = Field(min_length=1, max_length=255)
    """The name of the LoRa model to use."""
    model: float = Field(default=1, ge=-5, le=5)
    """The strength of the LoRa against the stable diffusion model."""
    clip: float = Field(default=1, ge=-5, le=5)
    """The strength of the LoRa against the clip model."""
    inject_trigger: str | None = Field(default=None, min_length=1, max_length=30)
    """Any trigger required to activate the LoRa model."""
    is_version: bool = Field(default=False)
    """If true, will treat the lora name as a version ID."""

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

name class-attribute instance-attribute 

name: str = Field(min_length=1, max_length=255)

The name of the LoRa model to use.

model class-attribute instance-attribute 

model: float = Field(default=1, ge=-5, le=5)

The strength of the LoRa against the stable diffusion model.

clip class-attribute instance-attribute 

clip: float = Field(default=1, ge=-5, le=5)

The strength of the LoRa against the clip model.

inject_trigger class-attribute instance-attribute 

inject_trigger: str | None = Field(default=None, min_length=1, max_length=30)

Any trigger required to activate the LoRa model.

is_version class-attribute instance-attribute 

is_version: bool = Field(default=False)

If true, will treat the lora name as a version ID.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/base.py 
117
118
119
120
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "ModelPayloadLorasStable"

TIPayloadEntry

Bases: HordeAPIObjectBaseModel

Represents a single textual inversion (embedding) parameter.

v2 API Model: ModelPayloadTextualInversionsStable

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
123
124
125
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
class TIPayloadEntry(HordeAPIObjectBaseModel):
    """Represents a single textual inversion (embedding) parameter.

    v2 API Model: `ModelPayloadTextualInversionsStable`
    """

    name: str = Field(min_length=1, max_length=255)
    """The name or ID of the textual inversion model to use."""
    inject_ti: str | None = None
    """Whether to automatically insert the TI into the prompt or negprompt."""
    strength: float = Field(default=1, ge=-5, le=5)
    """The strength to apply the textual inversion model."""

    @field_validator("inject_ti")
    def validate_inject_ti(cls, v: str | None) -> str | None:
        """Ensure that the inject_ti is either 'prompt' or 'negprompt'."""
        if v is None:
            return None
        if v not in ["prompt", "negprompt"]:
            raise ValueError("inject_ti must be either 'prompt' or 'negprompt'")
        return v

    @field_validator("strength")
    def validate_strength(cls, v: float) -> float:
        """Ensure that the strength is non-zero."""
        if v == 0:
            logger.debug("strength should be non-zero")

        return v

    @model_validator(mode="after")
    def strength_only_if_inject_ti(self) -> TIPayloadEntry:
        """Ensure that the strength is only set if the inject_ti is set."""
        if self.strength and self.inject_ti is None:
            logger.debug("strength is only valid when inject_ti is set")
        return self

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

name class-attribute instance-attribute 

name: str = Field(min_length=1, max_length=255)

The name or ID of the textual inversion model to use.

inject_ti class-attribute instance-attribute 

inject_ti: str | None = None

Whether to automatically insert the TI into the prompt or negprompt.

strength class-attribute instance-attribute 

strength: float = Field(default=1, ge=-5, le=5)

The strength to apply the textual inversion model.

validate_inject_ti 

validate_inject_ti(v: str | None) -> str | None

Ensure that the inject_ti is either 'prompt' or 'negprompt'.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
136
137
138
139
140
141
142
143
@field_validator("inject_ti")
def validate_inject_ti(cls, v: str | None) -> str | None:
    """Ensure that the inject_ti is either 'prompt' or 'negprompt'."""
    if v is None:
        return None
    if v not in ["prompt", "negprompt"]:
        raise ValueError("inject_ti must be either 'prompt' or 'negprompt'")
    return v

validate_strength 

validate_strength(v: float) -> float

Ensure that the strength is non-zero.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
145
146
147
148
149
150
151
@field_validator("strength")
def validate_strength(cls, v: float) -> float:
    """Ensure that the strength is non-zero."""
    if v == 0:
        logger.debug("strength should be non-zero")

    return v

strength_only_if_inject_ti 

strength_only_if_inject_ti() -> TIPayloadEntry

Ensure that the strength is only set if the inject_ti is set.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
153
154
155
156
157
158
@model_validator(mode="after")
def strength_only_if_inject_ti(self) -> TIPayloadEntry:
    """Ensure that the strength is only set if the inject_ti is set."""
    if self.strength and self.inject_ti is None:
        logger.debug("strength is only valid when inject_ti is set")
    return self

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/base.py 
160
161
162
163
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "ModelPayloadTextualInversionsStable"

ExtraSourceImageEntry

Bases: HordeAPIObjectBaseModel

Represents a single extra source image.

v2 API Model: ExtraSourceImage

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
class ExtraSourceImageEntry(HordeAPIObjectBaseModel):
    """Represents a single extra source image.

    v2 API Model: `ExtraSourceImage`
    """

    original_url: str | None = None
    """The URL of the original image after it was downloaded."""

    image: str = Field(min_length=1)
    """The URL of the image to download, or the base64 string once downloaded."""
    strength: float = Field(default=1, ge=-5, le=5)
    """The strength to apply to this image on various operations."""

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

original_url class-attribute instance-attribute 

original_url: str | None = None

The URL of the original image after it was downloaded.

image class-attribute instance-attribute 

image: str = Field(min_length=1)

The URL of the image to download, or the base64 string once downloaded.

strength class-attribute instance-attribute 

strength: float = Field(default=1, ge=-5, le=5)

The strength to apply to this image on various operations.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/base.py 
180
181
182
183
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "ExtraSourceImage"

ExtraTextEntry

Bases: HordeAPIObjectBaseModel

Represents a single extra text.

v2 API Model: ExtraText

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
class ExtraTextEntry(HordeAPIObjectBaseModel):
    """Represents a single extra text.

    v2 API Model: `ExtraText`
    """

    text: str = Field(min_length=1)
    """Extra text required for this generation."""
    reference: str = Field(min_length=3)
    """Reference pointing to how this text is to be used."""

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

text class-attribute instance-attribute 

text: str = Field(min_length=1)

Extra text required for this generation.

reference class-attribute instance-attribute 

reference: str = Field(min_length=3)

Reference pointing to how this text is to be used.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/base.py 
197
198
199
200
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "ExtraText"

SingleWarningEntry

Bases: HordeAPIObjectBaseModel

Represents a single warning.

v2 API Model: RequestSingleWarning

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
class SingleWarningEntry(HordeAPIObjectBaseModel):
    """Represents a single warning.

    v2 API Model: `RequestSingleWarning`
    """

    code: WarningCode | str = Field(min_length=1)
    """The code uniquely identifying this warning."""
    message: str = Field(min_length=1)
    """The human-readable description of this warning"""

    @field_validator("code")
    def code_must_be_known(cls, v: str | WarningCode) -> str | WarningCode:
        """Ensure that the warning code is in this list of supported warning codes."""
        if isinstance(v, WarningCode):
            return v
        if v not in WarningCode.__members__ or v not in WarningCode.__members__.values():
            logger.warning(f"Unknown warning code {v}. Is your SDK out of date or did the API change?")

        return v

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

code class-attribute instance-attribute 

code: WarningCode | str = Field(min_length=1)

The code uniquely identifying this warning.

message class-attribute instance-attribute 

message: str = Field(min_length=1)

The human-readable description of this warning

code_must_be_known 

code_must_be_known(v: str | WarningCode) -> str | WarningCode

Ensure that the warning code is in this list of supported warning codes.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
214
215
216
217
218
219
220
221
222
@field_validator("code")
def code_must_be_known(cls, v: str | WarningCode) -> str | WarningCode:
    """Ensure that the warning code is in this list of supported warning codes."""
    if isinstance(v, WarningCode):
        return v
    if v not in WarningCode.__members__ or v not in WarningCode.__members__.values():
        logger.warning(f"Unknown warning code {v}. Is your SDK out of date or did the API change?")

    return v

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/base.py 
224
225
226
227
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "RequestSingleWarning"

ImageGenerateParamMixin

Bases: HordeAPIObjectBaseModel

Mix-in class of some of the data included in a request to the /v2/generate/async endpoint.

Also is the corresponding information returned on a job pop to the /v2/generate/pop endpoint. v2 API Model: ModelPayloadRootStable

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
class ImageGenerateParamMixin(HordeAPIObjectBaseModel):
    """Mix-in class of some of the data included in a request to the `/v2/generate/async` endpoint.

    Also is the corresponding information returned on a job pop to the `/v2/generate/pop` endpoint.
    v2 API Model: `ModelPayloadRootStable`
    """

    model_config = (
        ConfigDict(frozen=True, extra="allow")
        if not os.getenv("TESTS_ONGOING")
        else ConfigDict(frozen=True, extra="forbid")
    )

    sampler_name: KNOWN_SAMPLERS | str = KNOWN_SAMPLERS.k_lms
    """The sampler to use for this generation. Defaults to `KNOWN_SAMPLERS.k_lms`."""
    cfg_scale: float = 7.5
    """The cfg_scale to use for this generation. Defaults to 7.5."""
    denoising_strength: float | None = Field(default=1, ge=0, le=1)
    """The denoising strength to use for this generation. Defaults to 1."""
    seed: str | None = None
    """The seed to use for this generation. If not provided, a random seed will be used."""
    height: int = Field(default=512, ge=64, le=3072)
    """The desired output image height."""
    width: int = Field(default=512, ge=64, le=3072)
    """The desired output image width."""
    seed_variation: int | None = Field(default=None, ge=1, le=1000)
    """Deprecated."""
    post_processing: list[str | KNOWN_UPSCALERS | KNOWN_FACEFIXERS | KNOWN_MISC_POST_PROCESSORS] = Field(
        default_factory=list,
    )
    """A list of post-processing models to use."""
    post_processing_order: POST_PROCESSOR_ORDER_TYPE = POST_PROCESSOR_ORDER_TYPE.facefixers_first
    """The order in which to apply post-processing models.
    Applying upscalers or removing backgrounds before facefixers costs less kudos."""
    karras: bool = True
    """Set to True if you want to use the Karras scheduling."""
    tiling: bool = False
    """Set to True if you want to use seamless tiling."""
    hires_fix: bool = False
    """Set to True if you want to use the hires fix."""
    hires_fix_denoising_strength: float | None = Field(default=None, ge=0, le=1)
    """The strength of the denoising for the hires fix second pass."""
    clip_skip: int = Field(default=1, ge=1, le=12)
    """The number of clip layers to skip."""
    control_type: str | KNOWN_CONTROLNETS | None = None
    """The type of control net type to use."""
    image_is_control: bool | None = None
    """Set to True if the image is a control image."""
    return_control_map: bool | None = None
    """Set to True if you want the ControlNet map returned instead of a generated image."""
    facefixer_strength: float | None = Field(default=None, ge=0, le=1)
    """The strength of the facefixer model."""
    loras: list[LorasPayloadEntry] | None = None
    """A list of lora parameters to use."""
    tis: list[TIPayloadEntry] | None = None
    """A list of textual inversion (embedding) parameters to use."""
    extra_texts: list[ExtraTextEntry] | None = None
    """A list of extra texts and prompts to use in the comfyUI workflow."""
    workflow: str | KNOWN_WORKFLOWS | None = None
    """The specific comfyUI workflow to use."""
    transparent: bool | None = None
    """When true, will generate an image with a transparent background"""
    special: dict[Any, Any] | None = None
    """Reserved for future use."""
    use_nsfw_censor: bool = False
    """If the request is SFW, and the worker accidentally generates NSFW, it will send back a censored image."""

    @field_validator("width", "height", mode="before")
    def width_divisible_by_64(cls, value: int) -> int:
        """Ensure that the width is divisible by 64."""
        if value % 64 != 0:
            raise ValueError("width must be divisible by 64")
        return value

    @field_validator("sampler_name")
    def sampler_name_must_be_known(cls, v: str | KNOWN_SAMPLERS) -> str | KNOWN_SAMPLERS:
        """Ensure that the sampler name is in this list of supported samplers."""
        if isinstance(v, KNOWN_SAMPLERS):
            return v

        try:
            KNOWN_SAMPLERS(v)
        except ValueError:
            logger.warning(f"Unknown sampler name {v}. Is your SDK out of date or did the API change?")

        return v

    # @model_validator(mode="after")
    # def validate_hires_fix(self) -> ImageGenerateParamMixin:
    #     if self.hires_fix and (self.width < 512 or self.height < 512):
    #         raise ValueError("hires_fix is only valid when width and height are both >= 512")
    #     return self

    @field_validator("seed")
    def random_seed_if_none(cls, v: str | None) -> str | None:
        """If the seed is None, generate a random seed."""
        if v is None:
            random_seed = str(random.randint(1, 1000000000))
            logger.debug(f"Using random seed ({random_seed})")
            return random_seed

        return v

    @field_validator("post_processing")
    def post_processors_must_be_known(
        cls,
        v: list[str | KNOWN_UPSCALERS | KNOWN_FACEFIXERS | KNOWN_MISC_POST_PROCESSORS],
    ) -> list[str | KNOWN_UPSCALERS | KNOWN_FACEFIXERS | KNOWN_MISC_POST_PROCESSORS]:
        """Ensure that the post processors are in this list of supported post processors."""
        _valid_types: list[type] = [str, KNOWN_UPSCALERS, KNOWN_FACEFIXERS, KNOWN_MISC_POST_PROCESSORS]
        for post_processor in v:
            if post_processor not in _all_valid_post_processors_names_and_values or (
                type(post_processor) not in _valid_types
            ):
                logger.warning(
                    f"Unknown post processor {post_processor}. Is your SDK out of date or did the API change?",
                )
        return v

    @field_validator("control_type")
    def control_type_must_be_known(cls, v: str | KNOWN_CONTROLNETS | None) -> str | KNOWN_CONTROLNETS | None:
        """Ensure that the control type is in this list of supported control types."""
        if v is None:
            return None
        if isinstance(v, KNOWN_CONTROLNETS):
            return v

        try:
            KNOWN_CONTROLNETS(v)
        except ValueError:
            logger.warning(f"Unknown control type {v}. Is your SDK out of date or did the API change?")

        return v

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

model_config class-attribute instance-attribute 

model_config = ConfigDict(frozen=True, extra='allow') if not getenv('TESTS_ONGOING') else ConfigDict(frozen=True, extra='forbid')

sampler_name class-attribute instance-attribute 

sampler_name: KNOWN_SAMPLERS | str = k_lms

The sampler to use for this generation. Defaults to KNOWN_SAMPLERS.k_lms.

cfg_scale class-attribute instance-attribute 

cfg_scale: float = 7.5

The cfg_scale to use for this generation. Defaults to 7.5.

denoising_strength class-attribute instance-attribute 

denoising_strength: float | None = Field(default=1, ge=0, le=1)

The denoising strength to use for this generation. Defaults to 1.

seed class-attribute instance-attribute 

seed: str | None = None

The seed to use for this generation. If not provided, a random seed will be used.

height class-attribute instance-attribute 

height: int = Field(default=512, ge=64, le=3072)

The desired output image height.

width class-attribute instance-attribute 

width: int = Field(default=512, ge=64, le=3072)

The desired output image width.

seed_variation class-attribute instance-attribute 

seed_variation: int | None = Field(default=None, ge=1, le=1000)

Deprecated.

post_processing class-attribute instance-attribute 

post_processing: list[str | KNOWN_UPSCALERS | KNOWN_FACEFIXERS | KNOWN_MISC_POST_PROCESSORS] = Field(default_factory=list)

A list of post-processing models to use.

post_processing_order class-attribute instance-attribute 

post_processing_order: POST_PROCESSOR_ORDER_TYPE = facefixers_first

The order in which to apply post-processing models. Applying upscalers or removing backgrounds before facefixers costs less kudos.

karras class-attribute instance-attribute 

karras: bool = True

Set to True if you want to use the Karras scheduling.

tiling class-attribute instance-attribute 

tiling: bool = False

Set to True if you want to use seamless tiling.

hires_fix class-attribute instance-attribute 

hires_fix: bool = False

Set to True if you want to use the hires fix.

hires_fix_denoising_strength class-attribute instance-attribute 

hires_fix_denoising_strength: float | None = Field(default=None, ge=0, le=1)

The strength of the denoising for the hires fix second pass.

clip_skip class-attribute instance-attribute 

clip_skip: int = Field(default=1, ge=1, le=12)

The number of clip layers to skip.

control_type class-attribute instance-attribute 

control_type: str | KNOWN_CONTROLNETS | None = None

The type of control net type to use.

image_is_control class-attribute instance-attribute 

image_is_control: bool | None = None

Set to True if the image is a control image.

return_control_map class-attribute instance-attribute 

return_control_map: bool | None = None

Set to True if you want the ControlNet map returned instead of a generated image.

facefixer_strength class-attribute instance-attribute 

facefixer_strength: float | None = Field(default=None, ge=0, le=1)

The strength of the facefixer model.

loras class-attribute instance-attribute 

loras: list[LorasPayloadEntry] | None = None

A list of lora parameters to use.

tis class-attribute instance-attribute 

tis: list[TIPayloadEntry] | None = None

A list of textual inversion (embedding) parameters to use.

extra_texts class-attribute instance-attribute 

extra_texts: list[ExtraTextEntry] | None = None

A list of extra texts and prompts to use in the comfyUI workflow.

workflow class-attribute instance-attribute 

workflow: str | KNOWN_WORKFLOWS | None = None

The specific comfyUI workflow to use.

transparent class-attribute instance-attribute 

transparent: bool | None = None

When true, will generate an image with a transparent background

special class-attribute instance-attribute 

special: dict[Any, Any] | None = None

Reserved for future use.

use_nsfw_censor class-attribute instance-attribute 

use_nsfw_censor: bool = False

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

width_divisible_by_64 

width_divisible_by_64(value: int) -> int

Ensure that the width is divisible by 64.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
297
298
299
300
301
302
@field_validator("width", "height", mode="before")
def width_divisible_by_64(cls, value: int) -> int:
    """Ensure that the width is divisible by 64."""
    if value % 64 != 0:
        raise ValueError("width must be divisible by 64")
    return value

sampler_name_must_be_known 

sampler_name_must_be_known(v: str | KNOWN_SAMPLERS) -> str | KNOWN_SAMPLERS

Ensure that the sampler name is in this list of supported samplers.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
304
305
306
307
308
309
310
311
312
313
314
315
@field_validator("sampler_name")
def sampler_name_must_be_known(cls, v: str | KNOWN_SAMPLERS) -> str | KNOWN_SAMPLERS:
    """Ensure that the sampler name is in this list of supported samplers."""
    if isinstance(v, KNOWN_SAMPLERS):
        return v

    try:
        KNOWN_SAMPLERS(v)
    except ValueError:
        logger.warning(f"Unknown sampler name {v}. Is your SDK out of date or did the API change?")

    return v

random_seed_if_none 

random_seed_if_none(v: str | None) -> str | None

If the seed is None, generate a random seed.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
323
324
325
326
327
328
329
330
331
@field_validator("seed")
def random_seed_if_none(cls, v: str | None) -> str | None:
    """If the seed is None, generate a random seed."""
    if v is None:
        random_seed = str(random.randint(1, 1000000000))
        logger.debug(f"Using random seed ({random_seed})")
        return random_seed

    return v

post_processors_must_be_known 

post_processors_must_be_known(v: list[str | KNOWN_UPSCALERS | KNOWN_FACEFIXERS | KNOWN_MISC_POST_PROCESSORS]) -> list[str | KNOWN_UPSCALERS | KNOWN_FACEFIXERS | KNOWN_MISC_POST_PROCESSORS]

Ensure that the post processors are in this list of supported post processors.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
@field_validator("post_processing")
def post_processors_must_be_known(
    cls,
    v: list[str | KNOWN_UPSCALERS | KNOWN_FACEFIXERS | KNOWN_MISC_POST_PROCESSORS],
) -> list[str | KNOWN_UPSCALERS | KNOWN_FACEFIXERS | KNOWN_MISC_POST_PROCESSORS]:
    """Ensure that the post processors are in this list of supported post processors."""
    _valid_types: list[type] = [str, KNOWN_UPSCALERS, KNOWN_FACEFIXERS, KNOWN_MISC_POST_PROCESSORS]
    for post_processor in v:
        if post_processor not in _all_valid_post_processors_names_and_values or (
            type(post_processor) not in _valid_types
        ):
            logger.warning(
                f"Unknown post processor {post_processor}. Is your SDK out of date or did the API change?",
            )
    return v

control_type_must_be_known 

control_type_must_be_known(v: str | KNOWN_CONTROLNETS | None) -> str | KNOWN_CONTROLNETS | None

Ensure that the control type is in this list of supported control types.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
349
350
351
352
353
354
355
356
357
358
359
360
361
362
@field_validator("control_type")
def control_type_must_be_known(cls, v: str | KNOWN_CONTROLNETS | None) -> str | KNOWN_CONTROLNETS | None:
    """Ensure that the control type is in this list of supported control types."""
    if v is None:
        return None
    if isinstance(v, KNOWN_CONTROLNETS):
        return v

    try:
        KNOWN_CONTROLNETS(v)
    except ValueError:
        logger.warning(f"Unknown control type {v}. Is your SDK out of date or did the API change?")

    return v

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/base.py 
364
365
366
367
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "ModelPayloadRootStable"

JobSubmitResponse

Bases: HordeResponseBaseModel

The response to a job submission request, indicating the number of kudos gained.

v2 API Model: GenerationSubmitted

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
370
371
372
373
374
375
376
377
378
379
380
381
382
class JobSubmitResponse(HordeResponseBaseModel):
    """The response to a job submission request, indicating the number of kudos gained.

    v2 API Model: `GenerationSubmitted`
    """

    reward: float
    """The amount of kudos gained for submitting this request."""

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

reward instance-attribute 

reward: float

The amount of kudos gained for submitting this request.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/base.py 
379
380
381
382
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "GenerationSubmitted"

GenMetadataEntry

Bases: HordeAPIObjectBaseModel

Represents a single generation metadata entry.

v2 API Model: GenerationMetadataStable

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
class GenMetadataEntry(HordeAPIObjectBaseModel):
    """Represents a single generation metadata entry.

    v2 API Model: `GenerationMetadataStable`
    """

    type_: METADATA_TYPE | str = Field(alias="type")
    """The relevance of the metadata field."""
    value: METADATA_VALUE | str = Field()
    """The value of the metadata field."""
    ref: str | None = Field(default=None, max_length=255)
    """Optionally a reference for the metadata (e.g. a lora ID)"""

    @field_validator("type_")
    def validate_type(cls, v: str | METADATA_TYPE) -> str | METADATA_TYPE:
        """Ensure that the type is in this list of supported types."""
        if isinstance(v, METADATA_TYPE):
            return v
        if isinstance(v, str) and v not in METADATA_TYPE.__members__:
            logger.warning(f"Unknown metadata type {v}. Is your SDK out of date or did the API change?")
        return v

    @field_validator("value")
    def validate_value(cls, v: str | METADATA_VALUE) -> str | METADATA_VALUE:
        """Ensure that the value is in this list of supported values."""
        if isinstance(v, METADATA_VALUE):
            return v
        if isinstance(v, str) and v not in METADATA_VALUE.__members__:
            logger.warning(f"Unknown metadata value {v}. Is your SDK out of date or did the API change?")
        return v

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

type_ class-attribute instance-attribute 

type_: METADATA_TYPE | str = Field(alias='type')

The relevance of the metadata field.

value class-attribute instance-attribute 

value: METADATA_VALUE | str = Field()

The value of the metadata field.

ref class-attribute instance-attribute 

ref: str | None = Field(default=None, max_length=255)

Optionally a reference for the metadata (e.g. a lora ID)

validate_type 

validate_type(v: str | METADATA_TYPE) -> str | METADATA_TYPE

Ensure that the type is in this list of supported types.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
398
399
400
401
402
403
404
405
@field_validator("type_")
def validate_type(cls, v: str | METADATA_TYPE) -> str | METADATA_TYPE:
    """Ensure that the type is in this list of supported types."""
    if isinstance(v, METADATA_TYPE):
        return v
    if isinstance(v, str) and v not in METADATA_TYPE.__members__:
        logger.warning(f"Unknown metadata type {v}. Is your SDK out of date or did the API change?")
    return v

validate_value 

validate_value(v: str | METADATA_VALUE) -> str | METADATA_VALUE

Ensure that the value is in this list of supported values.

Source code in horde_sdk/ai_horde_api/apimodels/base.py 
407
408
409
410
411
412
413
414
@field_validator("value")
def validate_value(cls, v: str | METADATA_VALUE) -> str | METADATA_VALUE:
    """Ensure that the value is in this list of supported values."""
    if isinstance(v, METADATA_VALUE):
        return v
    if isinstance(v, str) and v not in METADATA_VALUE.__members__:
        logger.warning(f"Unknown metadata value {v}. Is your SDK out of date or did the API change?")
    return v

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/base.py 
416
417
418
419
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "GenerationMetadataStable"