Check if there are generation requests queued for fulfillment

This endpoint is used by registered workers only

post/v2/generate/pop

Request

Base URL
/api (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared. Required headers: apikey
TypeScript
https://skmtc.dev/haidra-org/apis/ai-horde/docs/v2/generate/pop/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

apikeystring required

The API Key corresponding to a registered user.

X-Fieldsstring mask

An optional fields mask

Request body

namestring

The Name of the Worker.

priority_usernamesstring[]

nsfwboolean

Whether this worker can generate NSFW requests or not.

modelsstring[]

bridge_agentstring

The worker name, version and website.

threadsinteger

How many threads this worker is running. This is used to accurately the current power available in the horde.

require_upfront_kudosboolean

If True, this worker will only pick up requests where the owner has the required kudos to consume already available.

amountinteger

How many jobvs to pop at the same time

max_pixelsinteger

The maximum amount of pixels this worker can generate.

blackliststring[]

allow_img2imgboolean

If True, this worker will pick up img2img requests.

allow_paintingboolean

If True, this worker will pick up inpainting/outpainting requests.

allow_unsafe_ipaddrboolean

If True, this worker will pick up img2img requests coming from clients with an unsafe IP.

allow_post_processingboolean

If True, this worker will pick up requests requesting post-processing.

allow_controlnetboolean

If True, this worker will pick up requests requesting ControlNet.

allow_loraboolean

If True, this worker will pick up requests requesting LoRas.

Example request

{
  "bridge_agent": "AI Horde Worker reGen:4.1.0:https://github.com/Haidra-Org/horde-worker-reGen"
}

Response

Generation Popped

idstring

The UUID for this image generation.

idsstring[]

modelstring

Which of the available models to use for this request.

source_imagestring

The Base64-encoded webp to use for img2img.

source_processing'img2img' | 'inpainting' | 'outpainting' | 'remix'

If source_image is provided, specifies how to process it.

source_maskstring

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

r2_uploadstring

The r2 upload link to use to upload this image.

r2_uploadsstring[]

Example response

{
  "payload": {
    "sampler_name": "k_euler",
    "denoising_strength": 0.75,
    "seed": "The little seed that could",
    "seed_variation": 1,
    "post_processing": [
      "GFPGAN"
    ],
    "clip_skip": 1,
    "control_type": "canny",
    "facefixer_strength": 0.75,
    "loras": [
      {
        "name": "Magnagothica"
      }
    ],
    "tis": [
      {
        "name": "7808",
        "inject_ti": "prompt"
      }
    ]
  },
  "ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "source_processing": "img2img"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.