consts

AI-Horde specific constants, including enums defined on the API.

GENERATION_MAX_LIFE module-attribute

GENERATION_MAX_LIFE = 60 * 20 - 30

The maximum time for the life of a generation request in seconds, minus 30 seconds to account for network latency.

This is the amount of time that passes before the server will delete the request.

DEFAULT_POST_PROCESSOR_ORDER module-attribute

DEFAULT_POST_PROCESSOR_ORDER = facefixers_first

The default post processor order.

GENERATION_STATE

Bases: StrEnum

The generation states that are known to the API.

(ok, censored, faulted, etc...)

Source code in horde_sdk/ai_horde_api/consts.py

class GENERATION_STATE(StrEnum):
    """The generation states that are known to the API.

    (ok, censored, faulted, etc...)
    """

    _NONE = ""  # FIXME

    ok = auto()
    """The generation was successful. It still may have encountered warnings."""
    censored = auto()
    """The generation was censored."""
    faulted = auto()
    """The generation encountered an error and was cancelled. It usually is retried automatically."""
    csam = auto()
    """The generation was flagged as CSAM and automatically censored."""
    waiting = auto()
    """The generation is waiting for a worker to be assigned."""
    processing = auto()
    """The generation is being processed by a worker."""
    partial = auto()
    """The generation was returned partially complete."""
    cancelled = auto()
    """The generation was cancelled by the user."""
    done = auto()

ok class-attribute instance-attribute

ok = auto()

The generation was successful. It still may have encountered warnings.

censored class-attribute instance-attribute

censored = auto()

The generation was censored.

faulted class-attribute instance-attribute

faulted = auto()

The generation encountered an error and was cancelled. It usually is retried automatically.

csam class-attribute instance-attribute

csam = auto()

The generation was flagged as CSAM and automatically censored.

waiting class-attribute instance-attribute

waiting = auto()

The generation is waiting for a worker to be assigned.

processing class-attribute instance-attribute

processing = auto()

The generation is being processed by a worker.

partial class-attribute instance-attribute

partial = auto()

The generation was returned partially complete.

cancelled class-attribute instance-attribute

cancelled = auto()

The generation was cancelled by the user.

done class-attribute instance-attribute

done = auto()

WORKER_TYPE

Bases: StrEnum

The worker types that are known to the API.

(alchemy, image, text, etc...)

Source code in horde_sdk/ai_horde_api/consts.py

class WORKER_TYPE(StrEnum):
    """The worker types that are known to the API.

    (alchemy, image, text, etc...)
    """

    all = ""
    """All worker types."""
    image = auto()
    """Image generation worker."""
    text = auto()
    """Text generation worker."""
    interrogation = auto()
    """Alchemy/Interrogation worker."""
    alchemist = "interrogation"
    """Alchemy/Interrogation worker."""

all class-attribute instance-attribute

all = ''

All worker types.

image class-attribute instance-attribute

image = auto()

Image generation worker.

text class-attribute instance-attribute

text = auto()

Text generation worker.

interrogation class-attribute instance-attribute

interrogation = auto()

Alchemy/Interrogation worker.

alchemist class-attribute instance-attribute

alchemist = 'interrogation'

Alchemy/Interrogation worker.

ALCHEMY_FORMS

Bases: StrEnum

Forms (type of services) for alchemist type workers.

(nsfw, caption, interrogation, post_process, etc...)

Source code in horde_sdk/ai_horde_api/consts.py

class ALCHEMY_FORMS(StrEnum):
    """Forms (type of services) for alchemist type workers.

    (nsfw, caption, interrogation, post_process, etc...)
    """

    nsfw = auto()
    caption = auto()
    """Captioning (i.e., BLIP)."""
    interrogation = auto()
    """Interrogation (i.e., CLIP)."""
    post_process = auto()
    """Upscaling, facefixing, etc."""

nsfw class-attribute instance-attribute

nsfw = auto()

caption class-attribute instance-attribute

caption = auto()

Captioning (i.e., BLIP).

interrogation class-attribute instance-attribute

interrogation = auto()

Interrogation (i.e., CLIP).

post_process class-attribute instance-attribute

post_process = auto()

Upscaling, facefixing, etc.

KNOWN_SAMPLERS

Bases: StrEnum

The samplers that are known to the API.

(k_lms, k_heun, DDIM, etc)

Source code in horde_sdk/ai_horde_api/consts.py

class KNOWN_SAMPLERS(StrEnum):
    """The samplers that are known to the API.

    (k_lms, k_heun, DDIM, etc)
    """

    k_lms = auto()
    k_heun = auto()
    k_euler = auto()
    k_euler_a = auto()
    k_dpm_2 = auto()
    k_dpm_2_a = auto()
    k_dpm_fast = auto()
    k_dpm_adaptive = auto()
    k_dpmpp_2s_a = auto()
    k_dpmpp_2m = auto()
    dpmsolver = auto()
    k_dpmpp_sde = auto()
    lcm = auto()
    DDIM = "DDIM"

k_lms class-attribute instance-attribute

k_lms = auto()

k_heun class-attribute instance-attribute

k_heun = auto()

k_euler class-attribute instance-attribute

k_euler = auto()

k_euler_a class-attribute instance-attribute

k_euler_a = auto()

k_dpm_2 class-attribute instance-attribute

k_dpm_2 = auto()

k_dpm_2_a class-attribute instance-attribute

k_dpm_2_a = auto()

k_dpm_fast class-attribute instance-attribute

k_dpm_fast = auto()

k_dpm_adaptive class-attribute instance-attribute

k_dpm_adaptive = auto()

k_dpmpp_2s_a class-attribute instance-attribute

k_dpmpp_2s_a = auto()

k_dpmpp_2m class-attribute instance-attribute

k_dpmpp_2m = auto()

dpmsolver class-attribute instance-attribute

dpmsolver = auto()

k_dpmpp_sde class-attribute instance-attribute

k_dpmpp_sde = auto()

lcm class-attribute instance-attribute

lcm = auto()

DDIM class-attribute instance-attribute

DDIM = 'DDIM'

KNOWN_CONTROLNETS

Bases: StrEnum

The controlnets that are known to the API.

Source code in horde_sdk/ai_horde_api/consts.py

class KNOWN_CONTROLNETS(StrEnum):
    """The controlnets that are known to the API."""

    canny = auto()
    hed = auto()
    depth = auto()
    normal = auto()
    openpose = auto()
    seg = auto()
    scribble = auto()
    fakescribbles = auto()
    hough = auto()

canny class-attribute instance-attribute

canny = auto()

hed class-attribute instance-attribute

hed = auto()

depth class-attribute instance-attribute

depth = auto()

normal class-attribute instance-attribute

normal = auto()

openpose class-attribute instance-attribute

openpose = auto()

seg class-attribute instance-attribute

seg = auto()

scribble class-attribute instance-attribute

scribble = auto()

fakescribbles class-attribute instance-attribute

fakescribbles = auto()

hough class-attribute instance-attribute

hough = auto()

KNOWN_WORKFLOWS

Bases: StrEnum

The controlnets that are known to the API.

Source code in horde_sdk/ai_horde_api/consts.py

class KNOWN_WORKFLOWS(StrEnum):
    """The controlnets that are known to the API."""

    qr_code = auto()

qr_code class-attribute instance-attribute

qr_code = auto()

KNOWN_SOURCE_PROCESSING

Bases: StrEnum

The source processing methods that are known to the API.

(txt2img, img2img, inpainting, etc)

Source code in horde_sdk/ai_horde_api/consts.py

class KNOWN_SOURCE_PROCESSING(StrEnum):
    """The source processing methods that are known to the API.

    (txt2img, img2img, inpainting, etc)
    """

    txt2img = auto()
    img2img = auto()
    inpainting = auto()
    outpainting = auto()
    remix = auto()
    """Stable Cascade Remix"""

txt2img class-attribute instance-attribute

txt2img = auto()

img2img class-attribute instance-attribute

img2img = auto()

inpainting class-attribute instance-attribute

inpainting = auto()

outpainting class-attribute instance-attribute

outpainting = auto()

remix class-attribute instance-attribute

remix = auto()

Stable Cascade Remix

KNOWN_UPSCALERS

Bases: StrEnum

The upscalers that are known to the API.

(RealESRGAN_x4plus, RealESRGAN_x2plus, RealESRGAN_x4plus_anime_6B, etc)

Source code in horde_sdk/ai_horde_api/consts.py

class KNOWN_UPSCALERS(StrEnum):
    """The upscalers that are known to the API.

    (RealESRGAN_x4plus, RealESRGAN_x2plus, RealESRGAN_x4plus_anime_6B, etc)
    """

    RealESRGAN_x4plus = auto()
    RealESRGAN_x2plus = auto()
    RealESRGAN_x4plus_anime_6B = auto()
    NMKD_Siax = auto()
    four_4x_AnimeSharp = "4x_AnimeSharp"
    """AKA 4x_AnimeSharp"""

RealESRGAN_x4plus class-attribute instance-attribute

RealESRGAN_x4plus = auto()

RealESRGAN_x2plus class-attribute instance-attribute

RealESRGAN_x2plus = auto()

RealESRGAN_x4plus_anime_6B class-attribute instance-attribute

RealESRGAN_x4plus_anime_6B = auto()

NMKD_Siax class-attribute instance-attribute

NMKD_Siax = auto()

four_4x_AnimeSharp class-attribute instance-attribute

four_4x_AnimeSharp = '4x_AnimeSharp'

AKA 4x_AnimeSharp

KNOWN_FACEFIXERS

Bases: StrEnum

The facefixers that are known to the API.

(CodeFormers, etc)

Source code in horde_sdk/ai_horde_api/consts.py

class KNOWN_FACEFIXERS(StrEnum):
    """The facefixers that are known to the API.

    (CodeFormers, etc)
    """

    GFPGAN = auto()
    CodeFormers = auto()

GFPGAN class-attribute instance-attribute

GFPGAN = auto()

CodeFormers class-attribute instance-attribute

CodeFormers = auto()

KNOWN_MISC_POST_PROCESSORS

Bases: StrEnum

The misc post processors that are known to the API.

(strip_background, etc)

Source code in horde_sdk/ai_horde_api/consts.py

class KNOWN_MISC_POST_PROCESSORS(StrEnum):
    """The misc post processors that are known to the API.

    (strip_background, etc)
    """

    strip_background = auto()

strip_background class-attribute instance-attribute

strip_background = auto()

POST_PROCESSOR_ORDER_TYPE

Bases: StrEnum

The post processor order types that are known to the API.

(facefixers_first, upscalers_first, custom, etc)

Source code in horde_sdk/ai_horde_api/consts.py

class POST_PROCESSOR_ORDER_TYPE(StrEnum):
    """The post processor order types that are known to the API.

    (facefixers_first, upscalers_first, custom, etc)
    """

    facefixers_first = auto()
    """The facefixers are processed first."""
    upscalers_first = auto()
    """The upscalers are processed first."""
    custom = auto()
    """User specified post processor order."""

facefixers_first class-attribute instance-attribute

facefixers_first = auto()

The facefixers are processed first.

upscalers_first class-attribute instance-attribute

upscalers_first = auto()

The upscalers are processed first.

custom class-attribute instance-attribute

custom = auto()

User specified post processor order.

KNOWN_CLIP_BLIP_TYPES

Bases: StrEnum

The CLIP and BLIP models that are known to the API.

Source code in horde_sdk/ai_horde_api/consts.py

class KNOWN_CLIP_BLIP_TYPES(StrEnum):
    """The CLIP and BLIP models that are known to the API."""

    caption = auto()
    """The caption (BLIP) model."""
    interrogation = auto()
    """The interrogation (CLIP) model."""
    nsfw = auto()
    """The NSFW model."""

caption class-attribute instance-attribute

caption = auto()

The caption (BLIP) model.

interrogation class-attribute instance-attribute

interrogation = auto()

The interrogation (CLIP) model.

nsfw class-attribute instance-attribute

nsfw = auto()

The NSFW model.

KNOWN_INTERROGATORS

Bases: StrEnum

The interrogators that are known to the API.

Source code in horde_sdk/ai_horde_api/consts.py

class KNOWN_INTERROGATORS(StrEnum):
    """The interrogators that are known to the API."""

    vit_l_14 = "ViT-L/14"

vit_l_14 class-attribute instance-attribute

vit_l_14 = 'ViT-L/14'

KNOWN_ALCHEMY_TYPES

Bases: StrEnum

The alchemy processes (types) that are known to the API.

(caption, GFPGAN, strip_background, etc)

Source code in horde_sdk/ai_horde_api/consts.py

class KNOWN_ALCHEMY_TYPES(StrEnum):
    """The alchemy processes (types) that are known to the API.

    (caption, GFPGAN, strip_background, etc)
    """

    _NONE = ""  # FIXME

    caption = KNOWN_CLIP_BLIP_TYPES.caption
    interrogation = KNOWN_CLIP_BLIP_TYPES.interrogation
    nsfw = KNOWN_CLIP_BLIP_TYPES.nsfw

    RealESRGAN_x4plus = KNOWN_UPSCALERS.RealESRGAN_x4plus
    RealESRGAN_x2plus = KNOWN_UPSCALERS.RealESRGAN_x2plus
    RealESRGAN_x4plus_anime_6B = KNOWN_UPSCALERS.RealESRGAN_x4plus_anime_6B
    NMKD_Siax = KNOWN_UPSCALERS.NMKD_Siax
    fourx_AnimeSharp = KNOWN_UPSCALERS.four_4x_AnimeSharp

    GFPGAN = KNOWN_FACEFIXERS.GFPGAN
    CodeFormers = KNOWN_FACEFIXERS.GFPGAN

    strip_background = KNOWN_MISC_POST_PROCESSORS.strip_background

caption class-attribute instance-attribute

caption = caption

interrogation class-attribute instance-attribute

interrogation = interrogation

nsfw class-attribute instance-attribute

nsfw = nsfw

RealESRGAN_x4plus class-attribute instance-attribute

RealESRGAN_x4plus = RealESRGAN_x4plus

RealESRGAN_x2plus class-attribute instance-attribute

RealESRGAN_x2plus = RealESRGAN_x2plus

RealESRGAN_x4plus_anime_6B class-attribute instance-attribute

RealESRGAN_x4plus_anime_6B = RealESRGAN_x4plus_anime_6B

NMKD_Siax class-attribute instance-attribute

NMKD_Siax = NMKD_Siax

fourx_AnimeSharp class-attribute instance-attribute

fourx_AnimeSharp = four_4x_AnimeSharp

GFPGAN class-attribute instance-attribute

GFPGAN = GFPGAN

CodeFormers class-attribute instance-attribute

CodeFormers = GFPGAN

strip_background class-attribute instance-attribute

strip_background = strip_background

METADATA_TYPE

Bases: StrEnum

The generation metadata types that are known to the API.

(lora, ti, censorship, etc)

Source code in horde_sdk/ai_horde_api/consts.py

class METADATA_TYPE(StrEnum):
    """The generation metadata types that are known to the API.

    (lora, ti, censorship, etc)
    """

    lora = auto()
    """This refers to a LORA metadata type."""
    ti = auto()
    """This refers to a Textual Inversion metadata type."""
    censorship = auto()
    """The censorship metadata type."""
    source_image = auto()
    """The source image for img2img, inpainting, outpainting, or other source image processing."""
    source_mask = auto()
    """The mask for img2img, inpainting, outpainting, or other source image processing."""
    extra_source_images = auto()
    """Extra source images for the request."""
    batch_index = auto()
    """The index of the batch in a batch request."""
    information = auto()
    """Extra information about the image."""

lora class-attribute instance-attribute

lora = auto()

This refers to a LORA metadata type.

ti class-attribute instance-attribute

ti = auto()

This refers to a Textual Inversion metadata type.

censorship class-attribute instance-attribute

censorship = auto()

The censorship metadata type.

source_image class-attribute instance-attribute

source_image = auto()

The source image for img2img, inpainting, outpainting, or other source image processing.

source_mask class-attribute instance-attribute

source_mask = auto()

The mask for img2img, inpainting, outpainting, or other source image processing.

extra_source_images class-attribute instance-attribute

extra_source_images = auto()

Extra source images for the request.

batch_index class-attribute instance-attribute

batch_index = auto()

The index of the batch in a batch request.

information class-attribute instance-attribute

information = auto()

Extra information about the image.

METADATA_VALUE

Bases: StrEnum

The generation metadata values that are known to the API.

(download_failed, baseline_mismatch, etc)

Source code in horde_sdk/ai_horde_api/consts.py

class METADATA_VALUE(StrEnum):
    """The generation metadata values that are known to the API.

    (download_failed, baseline_mismatch, etc)
    """

    download_failed = auto()
    """Something in the request couldn't be downloaded."""
    parse_failed = auto()
    """Something in the request couldn't be parsed."""
    baseline_mismatch = auto()
    """The model targeted wasn't the correct baseline (e.g., SD15 when the request required SDXL)."""
    csam = auto()
    """The generation was flagged as CSAM and automatically censored."""
    nsfw = auto()
    """The generation is not safe for work."""
    see_ref = auto()
    """See the `ref` field for more information."""

download_failed class-attribute instance-attribute

download_failed = auto()

Something in the request couldn't be downloaded.

parse_failed class-attribute instance-attribute

parse_failed = auto()

Something in the request couldn't be parsed.

baseline_mismatch class-attribute instance-attribute

baseline_mismatch = auto()

The model targeted wasn't the correct baseline (e.g., SD15 when the request required SDXL).

csam class-attribute instance-attribute

csam = auto()

The generation was flagged as CSAM and automatically censored.

nsfw class-attribute instance-attribute

nsfw = auto()

The generation is not safe for work.

see_ref class-attribute instance-attribute

see_ref = auto()

See the ref field for more information.

MODEL_STATE

Bases: StrEnum

The model states that are known to the API.

Source code in horde_sdk/ai_horde_api/consts.py

class MODEL_STATE(StrEnum):
    """The model states that are known to the API."""

    all = auto()
    """Both known and custom models."""
    known = auto()
    """Known models that appear in the model reference"""
    custom = auto()
    """Custom models."""

all class-attribute instance-attribute

all = auto()

Both known and custom models.

known class-attribute instance-attribute

known = auto()

Known models that appear in the model reference

custom class-attribute instance-attribute

custom = auto()

Custom models.

MODEL_TYPE

Bases: StrEnum

The model types that are known to the API.

Source code in horde_sdk/ai_horde_api/consts.py

class MODEL_TYPE(StrEnum):
    """The model types that are known to the API."""

    text = auto()
    """Text generation models."""
    image = auto()
    """Image generation models."""

text class-attribute instance-attribute

text = auto()

Text generation models.

image class-attribute instance-attribute

image = auto()

Image generation models.

WarningCode

Bases: StrEnum

The warning codes that are known to the API.

Source code in horde_sdk/ai_horde_api/consts.py

class WarningCode(StrEnum):
    """The warning codes that are known to the API."""

    NoAvailableWorker = auto()
    """There are no available workers for the request."""
    ClipSkipMismatch = auto()
    """The clip skip value doesn't match the model's preferred value."""
    StepsTooFew = auto()
    """The number of steps are lower than recommended."""
    StepsTooMany = auto()
    """The number of steps are higher than recommended."""
    CfgScaleMismatch = auto()
    """The scale in the CFG doesn't match the model's preferred scale."""
    CfgScaleTooSmall = auto()
    """The scale in the CFG is too small for the model to handle."""
    CfgScaleTooLarge = auto()
    """The scale in the CFG is too large for the model to handle."""
    SamplerMismatch = auto()
    """The sampler specified doesn't match the model's preferred sampler."""
    SchedulerMismatch = auto()
    """The scheduler specified doesn't match the model's preferred scheduler."""

NoAvailableWorker class-attribute instance-attribute

NoAvailableWorker = auto()

There are no available workers for the request.

ClipSkipMismatch class-attribute instance-attribute

ClipSkipMismatch = auto()

The clip skip value doesn't match the model's preferred value.

StepsTooFew class-attribute instance-attribute

StepsTooFew = auto()

The number of steps are lower than recommended.

StepsTooMany class-attribute instance-attribute

StepsTooMany = auto()

The number of steps are higher than recommended.

CfgScaleMismatch class-attribute instance-attribute

CfgScaleMismatch = auto()

The scale in the CFG doesn't match the model's preferred scale.

CfgScaleTooSmall class-attribute instance-attribute

CfgScaleTooSmall = auto()

The scale in the CFG is too small for the model to handle.

CfgScaleTooLarge class-attribute instance-attribute

CfgScaleTooLarge = auto()

The scale in the CFG is too large for the model to handle.

SamplerMismatch class-attribute instance-attribute

SamplerMismatch = auto()

The sampler specified doesn't match the model's preferred sampler.

SchedulerMismatch class-attribute instance-attribute

SchedulerMismatch = auto()

The scheduler specified doesn't match the model's preferred scheduler.

RC

Bases: StrEnum

The return codes (typically errors, sometimes warnings) that are known to the API.

Source code in horde_sdk/ai_horde_api/consts.py

class RC(StrEnum):
    """The return codes (typically errors, sometimes warnings) that are known to the API."""

    MissingPrompt = auto()
    """The prompt is missing but is required."""
    CorruptPrompt = auto()
    """The prompt couldn't be parsed."""
    KudosValidationError = auto()
    """The number of kudos for the requesting user is too low."""
    NoValidActions = auto()
    InvalidSize = auto()
    InvalidPromptSize = auto()
    """The prompt is too short or too long."""
    TooManySteps = auto()
    """The number of steps too high to be reasonable."""
    Profanity = auto()
    ProfaneWorkerName = auto()
    """The worker name contains profanity or rude language."""
    ProfaneBridgeAgent = auto()
    """The bridge agent contains profanity or rude language."""
    ProfaneWorkerInfo = auto()
    """The worker info contains profanity or rude language."""
    ProfaneUserName = auto()
    """The user name contains profanity or rude language."""
    ProfaneUserContact = auto()
    """The user contact contains profanity or rude language."""
    ProfaneAdminComment = auto()
    """The admin comment contains profanity or rude language."""
    ProfaneTeamName = auto()
    """The team name contains profanity or rude language."""
    ProfaneTeamInfo = auto()
    """The team info contains profanity or rude language."""
    TooLong = auto()
    TooLongWorkerName = auto()
    """The worker name is too long."""
    TooLongUserName = auto()
    """The user name is too long."""
    NameAlreadyExists = auto()
    """The name is already in use."""
    WorkerNameAlreadyExists = auto()
    """The worker name is already in use."""
    TeamNameAlreadyExists = auto()
    """The team name is already in use."""
    PolymorphicNameConflict = auto()
    """The name conflicts with a polymorphic name in the database."""
    ImageValidationFailed = auto()
    """The image couldn't be parsed. This may be due to a corrupt image."""
    SourceImageResolutionExceeded = auto()
    SourceImageSizeExceeded = auto()
    SourceImageUrlInvalid = auto()
    """The source image URL is invalid or is not accessible."""
    SourceImageUnreadable = auto()
    InpaintingMissingMask = auto()
    """Inpainting was selected but no mask was provided."""
    SourceMaskUnnecessary = auto()
    UnsupportedSampler = auto()
    UnsupportedModel = auto()
    ControlNetUnsupported = auto()
    ControlNetSourceMissing = auto()
    ControlNetInvalidPayload = auto()
    SourceImageRequiredForModel = auto()
    """The model requires a source image."""
    UnexpectedModelName = auto()
    """The model name is unexpected or unknown."""
    TooManyUpscalers = auto()
    """The number of upscalers in the request is too high."""
    ProcGenNotFound = auto()
    InvalidAestheticAttempt = auto()
    AestheticsNotCompleted = auto()
    AestheticsNotPublic = auto()
    AestheticsDuplicate = auto()
    AestheticsMissing = auto()
    AestheticsSolo = auto()
    AestheticsConfused = auto()
    AestheticsAlreadyExist = auto()
    AestheticsServerRejected = auto()
    AestheticsServerError = auto()
    AestheticsServerDown = auto()
    AestheticsServerTimeout = auto()
    InvalidAPIKey = auto()
    """The API key specified is invalid."""
    WrongCredentials = auto()
    """The API key specified doesn't match the target action."""
    NotAdmin = auto()
    """Only admins can perform this action."""
    NotModerator = auto()
    """Only moderators can perform this action."""
    NotOwner = auto()
    NotPrivileged = auto()
    AnonForbidden = auto()
    AnonForbiddenWorker = auto()
    AnonForbiddenUserMod = auto()
    NotTrusted = auto()
    """Only trusted users can perform this action."""
    UntrustedTeamCreation = auto()
    UntrustedUnsafeIP = auto()
    WorkerMaintenance = auto()
    WorkerFlaggedMaintenance = auto()
    TooManySameIPs = auto()
    WorkerInviteOnly = auto()
    UnsafeIP = auto()
    TimeoutIP = auto()
    TooManyNewIPs = auto()
    KudosUpfront = auto()
    """The user must pay kudos upfront. This is typically only for anonymous users surpassing a certain kudos cost for
    their request."""
    SharedKeyEmpty = auto()
    SharedKeyExpired = auto()
    """The shared key has expired."""
    SharedKeyInsufficientKudos = auto()
    """The shared key doesn't have enough kudos to perform this action"""
    InvalidJobID = auto()
    """The job ID was not found, has timed out or has been deleted."""
    RequestNotFound = auto()
    """The request was not found, has timed out or has been deleted."""
    WorkerNotFound = auto()
    """The worker was not found."""
    TeamNotFound = auto()
    """The team was not found."""
    FilterNotFound = auto()
    """The filter was not found."""
    UserNotFound = auto()
    """The user was not found."""
    DuplicateGen = auto()
    AbortedGen = auto()
    RequestExpired = auto()
    TooManyPrompts = auto()
    NoValidWorkers = auto()
    MaintenanceMode = auto()
    TargetAccountFlagged = auto()
    SourceAccountFlagged = auto()
    FaultWhenKudosReceiving = auto()
    FaultWhenKudosSending = auto()
    TooFastKudosTransfers = auto()
    KudosTransferToAnon = auto()
    """The user is trying to transfer kudos to the anonymous user."""
    KudosTransferToSelf = auto()
    """The user is trying to transfer kudos to themselves."""
    KudosTransferNotEnough = auto()
    """The user doesn't have enough kudos to transfer."""
    NegativeKudosTransfer = auto()
    """The user is trying to transfer a negative amount of kudos."""
    KudosTransferFromAnon = auto()
    InvalidAwardUsername = auto()
    KudosAwardToAnon = auto()
    NotAllowedAwards = auto()
    NoWorkerModSelected = auto()
    NoUserModSelected = auto()
    NoHordeModSelected = auto()
    NoTeamModSelected = auto()
    NoFilterModSelected = auto()
    NoSharedKeyModSelected = auto()
    BadRequest = auto()
    Forbidden = auto()
    Locked = auto()
    ControlNetMismatch = auto()
    HiResFixMismatch = auto()
    TooManyLoras = auto()
    """The number of LORAs in the request is too high."""
    BadLoraVersion = auto()
    """The LORA version specficied is not valid."""
    TooManyTIs = auto()
    """The number of TIs in the request is too high."""
    BetaAnonForbidden = auto()
    BetaComparisonFault = auto()
    BadCFGDecimals = auto()
    """The number of decimals in the CFG is invalid."""
    BadCFGNumber = auto()
    """The number in the CFG is invalid."""
    BadClientAgent = auto()
    """The client agent is invalid."""
    SpecialMissingPayload = auto()
    SpecialForbidden = auto()
    SpecialMissingUsername = auto()
    SpecialModelNeedsSpecialUser = auto()
    SpecialFieldNeedsSpecialUser = auto()
    Img2ImgMismatch = auto()
    TilingMismatch = auto()
    EducationCannotSendKudos = auto()
    """The account is an education account and cannot send kudos."""
    InvalidPriorityUsername = auto()
    OnlyServiceAccountProxy = auto()
    """"Only accounts marked as service accounts can use this field."""
    RequiresTrust = auto()
    InvalidRemixModel = auto()
    InvalidExtraSourceImages = auto()
    TooManyExtraSourceImages = auto()
    MissingFullSamplerOrder = auto()
    TooManyStopSequences = auto()
    """The text request has too many stop sequences."""
    ExcessiveStopSequence = auto()
    """The text request has an excessive stop sequence."""
    TokenOverflow = auto()
    MoreThanMinExtraSourceImage = auto()

MissingPrompt class-attribute instance-attribute

MissingPrompt = auto()

The prompt is missing but is required.

CorruptPrompt class-attribute instance-attribute

CorruptPrompt = auto()

The prompt couldn't be parsed.

KudosValidationError class-attribute instance-attribute

KudosValidationError = auto()

The number of kudos for the requesting user is too low.

NoValidActions class-attribute instance-attribute

NoValidActions = auto()

InvalidSize class-attribute instance-attribute

InvalidSize = auto()

InvalidPromptSize class-attribute instance-attribute

InvalidPromptSize = auto()

The prompt is too short or too long.

TooManySteps class-attribute instance-attribute

TooManySteps = auto()

The number of steps too high to be reasonable.

Profanity class-attribute instance-attribute

Profanity = auto()

ProfaneWorkerName class-attribute instance-attribute

ProfaneWorkerName = auto()

The worker name contains profanity or rude language.

ProfaneBridgeAgent class-attribute instance-attribute

ProfaneBridgeAgent = auto()

The bridge agent contains profanity or rude language.

ProfaneWorkerInfo class-attribute instance-attribute

ProfaneWorkerInfo = auto()

The worker info contains profanity or rude language.

ProfaneUserName class-attribute instance-attribute

ProfaneUserName = auto()

The user name contains profanity or rude language.

ProfaneUserContact class-attribute instance-attribute

ProfaneUserContact = auto()

The user contact contains profanity or rude language.

ProfaneAdminComment class-attribute instance-attribute

ProfaneAdminComment = auto()

The admin comment contains profanity or rude language.

ProfaneTeamName class-attribute instance-attribute

ProfaneTeamName = auto()

The team name contains profanity or rude language.

ProfaneTeamInfo class-attribute instance-attribute

ProfaneTeamInfo = auto()

The team info contains profanity or rude language.

TooLong class-attribute instance-attribute

TooLong = auto()

TooLongWorkerName class-attribute instance-attribute

TooLongWorkerName = auto()

The worker name is too long.

TooLongUserName class-attribute instance-attribute

TooLongUserName = auto()

The user name is too long.

NameAlreadyExists class-attribute instance-attribute

NameAlreadyExists = auto()

The name is already in use.

WorkerNameAlreadyExists class-attribute instance-attribute

WorkerNameAlreadyExists = auto()

The worker name is already in use.

TeamNameAlreadyExists class-attribute instance-attribute

TeamNameAlreadyExists = auto()

The team name is already in use.

PolymorphicNameConflict class-attribute instance-attribute

PolymorphicNameConflict = auto()

The name conflicts with a polymorphic name in the database.

ImageValidationFailed class-attribute instance-attribute

ImageValidationFailed = auto()

The image couldn't be parsed. This may be due to a corrupt image.

SourceImageResolutionExceeded class-attribute instance-attribute

SourceImageResolutionExceeded = auto()

SourceImageSizeExceeded class-attribute instance-attribute

SourceImageSizeExceeded = auto()

SourceImageUrlInvalid class-attribute instance-attribute

SourceImageUrlInvalid = auto()

The source image URL is invalid or is not accessible.

SourceImageUnreadable class-attribute instance-attribute

SourceImageUnreadable = auto()

InpaintingMissingMask class-attribute instance-attribute

InpaintingMissingMask = auto()

Inpainting was selected but no mask was provided.

SourceMaskUnnecessary class-attribute instance-attribute

SourceMaskUnnecessary = auto()

UnsupportedSampler class-attribute instance-attribute

UnsupportedSampler = auto()

UnsupportedModel class-attribute instance-attribute

UnsupportedModel = auto()

ControlNetUnsupported class-attribute instance-attribute

ControlNetUnsupported = auto()

ControlNetSourceMissing class-attribute instance-attribute

ControlNetSourceMissing = auto()

ControlNetInvalidPayload class-attribute instance-attribute

ControlNetInvalidPayload = auto()

SourceImageRequiredForModel class-attribute instance-attribute

SourceImageRequiredForModel = auto()

The model requires a source image.

UnexpectedModelName class-attribute instance-attribute

UnexpectedModelName = auto()

The model name is unexpected or unknown.

TooManyUpscalers class-attribute instance-attribute

TooManyUpscalers = auto()

The number of upscalers in the request is too high.

ProcGenNotFound class-attribute instance-attribute

ProcGenNotFound = auto()

InvalidAestheticAttempt class-attribute instance-attribute

InvalidAestheticAttempt = auto()

AestheticsNotCompleted class-attribute instance-attribute

AestheticsNotCompleted = auto()

AestheticsNotPublic class-attribute instance-attribute

AestheticsNotPublic = auto()

AestheticsDuplicate class-attribute instance-attribute

AestheticsDuplicate = auto()

AestheticsMissing class-attribute instance-attribute

AestheticsMissing = auto()

AestheticsSolo class-attribute instance-attribute

AestheticsSolo = auto()

AestheticsConfused class-attribute instance-attribute

AestheticsConfused = auto()

AestheticsAlreadyExist class-attribute instance-attribute

AestheticsAlreadyExist = auto()

AestheticsServerRejected class-attribute instance-attribute

AestheticsServerRejected = auto()

AestheticsServerError class-attribute instance-attribute

AestheticsServerError = auto()

AestheticsServerDown class-attribute instance-attribute

AestheticsServerDown = auto()

AestheticsServerTimeout class-attribute instance-attribute

AestheticsServerTimeout = auto()

InvalidAPIKey class-attribute instance-attribute

InvalidAPIKey = auto()

The API key specified is invalid.

WrongCredentials class-attribute instance-attribute

WrongCredentials = auto()

The API key specified doesn't match the target action.

NotAdmin class-attribute instance-attribute

NotAdmin = auto()

Only admins can perform this action.

NotModerator class-attribute instance-attribute

NotModerator = auto()

Only moderators can perform this action.

NotOwner class-attribute instance-attribute

NotOwner = auto()

NotPrivileged class-attribute instance-attribute

NotPrivileged = auto()

AnonForbidden class-attribute instance-attribute

AnonForbidden = auto()

AnonForbiddenWorker class-attribute instance-attribute

AnonForbiddenWorker = auto()

AnonForbiddenUserMod class-attribute instance-attribute

AnonForbiddenUserMod = auto()

NotTrusted class-attribute instance-attribute

NotTrusted = auto()

Only trusted users can perform this action.

UntrustedTeamCreation class-attribute instance-attribute

UntrustedTeamCreation = auto()

UntrustedUnsafeIP class-attribute instance-attribute

UntrustedUnsafeIP = auto()

WorkerMaintenance class-attribute instance-attribute

WorkerMaintenance = auto()

WorkerFlaggedMaintenance class-attribute instance-attribute

WorkerFlaggedMaintenance = auto()

TooManySameIPs class-attribute instance-attribute

TooManySameIPs = auto()

WorkerInviteOnly class-attribute instance-attribute

WorkerInviteOnly = auto()

UnsafeIP class-attribute instance-attribute

UnsafeIP = auto()

TimeoutIP class-attribute instance-attribute

TimeoutIP = auto()

TooManyNewIPs class-attribute instance-attribute

TooManyNewIPs = auto()

KudosUpfront class-attribute instance-attribute

KudosUpfront = auto()

The user must pay kudos upfront. This is typically only for anonymous users surpassing a certain kudos cost for their request.

SharedKeyEmpty class-attribute instance-attribute

SharedKeyEmpty = auto()

SharedKeyExpired class-attribute instance-attribute

SharedKeyExpired = auto()

The shared key has expired.

SharedKeyInsufficientKudos class-attribute instance-attribute

SharedKeyInsufficientKudos = auto()

The shared key doesn't have enough kudos to perform this action

InvalidJobID class-attribute instance-attribute

InvalidJobID = auto()

The job ID was not found, has timed out or has been deleted.

RequestNotFound class-attribute instance-attribute

RequestNotFound = auto()

The request was not found, has timed out or has been deleted.

WorkerNotFound class-attribute instance-attribute

WorkerNotFound = auto()

The worker was not found.

TeamNotFound class-attribute instance-attribute

TeamNotFound = auto()

The team was not found.

FilterNotFound class-attribute instance-attribute

FilterNotFound = auto()

The filter was not found.

UserNotFound class-attribute instance-attribute

UserNotFound = auto()

The user was not found.

DuplicateGen class-attribute instance-attribute

DuplicateGen = auto()

AbortedGen class-attribute instance-attribute

AbortedGen = auto()

RequestExpired class-attribute instance-attribute

RequestExpired = auto()

TooManyPrompts class-attribute instance-attribute

TooManyPrompts = auto()

NoValidWorkers class-attribute instance-attribute

NoValidWorkers = auto()

MaintenanceMode class-attribute instance-attribute

MaintenanceMode = auto()

TargetAccountFlagged class-attribute instance-attribute

TargetAccountFlagged = auto()

SourceAccountFlagged class-attribute instance-attribute

SourceAccountFlagged = auto()

FaultWhenKudosReceiving class-attribute instance-attribute

FaultWhenKudosReceiving = auto()

FaultWhenKudosSending class-attribute instance-attribute

FaultWhenKudosSending = auto()

TooFastKudosTransfers class-attribute instance-attribute

TooFastKudosTransfers = auto()

KudosTransferToAnon class-attribute instance-attribute

KudosTransferToAnon = auto()

The user is trying to transfer kudos to the anonymous user.

KudosTransferToSelf class-attribute instance-attribute

KudosTransferToSelf = auto()

The user is trying to transfer kudos to themselves.

KudosTransferNotEnough class-attribute instance-attribute

KudosTransferNotEnough = auto()

The user doesn't have enough kudos to transfer.

NegativeKudosTransfer class-attribute instance-attribute

NegativeKudosTransfer = auto()

The user is trying to transfer a negative amount of kudos.

KudosTransferFromAnon class-attribute instance-attribute

KudosTransferFromAnon = auto()

InvalidAwardUsername class-attribute instance-attribute

InvalidAwardUsername = auto()

KudosAwardToAnon class-attribute instance-attribute

KudosAwardToAnon = auto()

NotAllowedAwards class-attribute instance-attribute

NotAllowedAwards = auto()

NoWorkerModSelected class-attribute instance-attribute

NoWorkerModSelected = auto()

NoUserModSelected class-attribute instance-attribute

NoUserModSelected = auto()

NoHordeModSelected class-attribute instance-attribute

NoHordeModSelected = auto()

NoTeamModSelected class-attribute instance-attribute

NoTeamModSelected = auto()

NoFilterModSelected class-attribute instance-attribute

NoFilterModSelected = auto()

NoSharedKeyModSelected class-attribute instance-attribute

NoSharedKeyModSelected = auto()

BadRequest class-attribute instance-attribute

BadRequest = auto()

Forbidden class-attribute instance-attribute

Forbidden = auto()

Locked class-attribute instance-attribute

Locked = auto()

ControlNetMismatch class-attribute instance-attribute

ControlNetMismatch = auto()

HiResFixMismatch class-attribute instance-attribute

HiResFixMismatch = auto()

TooManyLoras class-attribute instance-attribute

TooManyLoras = auto()

The number of LORAs in the request is too high.

BadLoraVersion class-attribute instance-attribute

BadLoraVersion = auto()

The LORA version specficied is not valid.

TooManyTIs class-attribute instance-attribute

TooManyTIs = auto()

The number of TIs in the request is too high.

BetaAnonForbidden class-attribute instance-attribute

BetaAnonForbidden = auto()

BetaComparisonFault class-attribute instance-attribute

BetaComparisonFault = auto()

BadCFGDecimals class-attribute instance-attribute

BadCFGDecimals = auto()

The number of decimals in the CFG is invalid.

BadCFGNumber class-attribute instance-attribute

BadCFGNumber = auto()

The number in the CFG is invalid.

BadClientAgent class-attribute instance-attribute

BadClientAgent = auto()

The client agent is invalid.

SpecialMissingPayload class-attribute instance-attribute

SpecialMissingPayload = auto()

SpecialForbidden class-attribute instance-attribute

SpecialForbidden = auto()

SpecialMissingUsername class-attribute instance-attribute

SpecialMissingUsername = auto()

SpecialModelNeedsSpecialUser class-attribute instance-attribute

SpecialModelNeedsSpecialUser = auto()

SpecialFieldNeedsSpecialUser class-attribute instance-attribute

SpecialFieldNeedsSpecialUser = auto()

Img2ImgMismatch class-attribute instance-attribute

Img2ImgMismatch = auto()

TilingMismatch class-attribute instance-attribute

TilingMismatch = auto()

EducationCannotSendKudos class-attribute instance-attribute

EducationCannotSendKudos = auto()

The account is an education account and cannot send kudos.

InvalidPriorityUsername class-attribute instance-attribute

InvalidPriorityUsername = auto()

OnlyServiceAccountProxy class-attribute instance-attribute

OnlyServiceAccountProxy = auto()

"Only accounts marked as service accounts can use this field.

RequiresTrust class-attribute instance-attribute

RequiresTrust = auto()

InvalidRemixModel class-attribute instance-attribute

InvalidRemixModel = auto()

InvalidExtraSourceImages class-attribute instance-attribute

InvalidExtraSourceImages = auto()

TooManyExtraSourceImages class-attribute instance-attribute

TooManyExtraSourceImages = auto()

MissingFullSamplerOrder class-attribute instance-attribute

MissingFullSamplerOrder = auto()

TooManyStopSequences class-attribute instance-attribute

TooManyStopSequences = auto()

The text request has too many stop sequences.

ExcessiveStopSequence class-attribute instance-attribute

ExcessiveStopSequence = auto()

The text request has an excessive stop sequence.

TokenOverflow class-attribute instance-attribute

TokenOverflow = auto()

MoreThanMinExtraSourceImage class-attribute instance-attribute

MoreThanMinExtraSourceImage = auto()

PROGRESS_STATE

Bases: StrEnum

The state of a request as seen on the server.

Source code in horde_sdk/ai_horde_api/consts.py

class PROGRESS_STATE(StrEnum):
    """The state of a request as seen on the server."""

    waiting = auto()
    finished = auto()
    timed_out = auto()

waiting class-attribute instance-attribute

waiting = auto()

finished class-attribute instance-attribute

finished = auto()

timed_out class-attribute instance-attribute

timed_out = auto()