Sign in

v1

latestSwagger 2.02026-07-176096209.1 KB
v2

Check if there are generation requests queued for fulfillment

This endpoint is used by registered workers only

post/v2/generate/text/pop

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_lengthinteger

The maximum amount of tokens this worker can generate.

max_context_lengthinteger

The max amount of context to submit to this AI for sampling.

softpromptsstring[]

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 generation.

Example response

{
  "payload": {
    "n": 1
  }
}