Sign in

v1

latestSwagger 2.02026-07-176096209.1 KB
v2

A List with the details of all registered and active workers

get/v2/workers

Query parameters

typestring

Filter the workers by type (image, text or interrogation).

Headers

apikeystring

A Moderator API key.

Client-Agentstring

The client name and version.

X-Fieldsstring mask

An optional fields mask

Response

Workers List

type'image' | 'text' | 'interrogation'

The Type of worker this is.

namestring

The Name given to this worker.

idstring

The UUID of this worker.

onlineboolean

True if the worker has checked-in the past 5 minutes.

requests_fulfilledinteger

How many images this worker has generated.

kudos_rewardsnumber

How many Kudos this worker has been rewarded in total.

performancestring

The average performance of this worker in human readable form.

threadsinteger

How many threads this worker is running.

uptimeinteger

The amount of seconds this worker has been online for this AI Horde.

maintenance_modeboolean

When True, this worker will not pick up any new requests.

pausedboolean

(Privileged) When True, this worker not be given any new requests.

infostring

Extra information or comments about this worker provided by its owner.

nsfwboolean

Whether this worker can generate NSFW requests or not.

ownerstring

Privileged or public if the owner has allowed it. The alias of the owner of this worker.

ipaddrstring

Privileged. The last known IP this worker has connected from.

trustedboolean

The worker is trusted to return valid generations.

flaggedboolean

The worker's owner has been flagged for suspicious activity. This worker will not be given any jobs to process.

suspiciousinteger

(Privileged) How much suspicion this worker has accumulated.

uncompleted_jobsinteger

How many jobs this worker has left uncompleted after it started them.

modelsstring[]
formsstring[]
contactstring

(Privileged) Contact details for the horde admins to reach the owner of this worker in emergencies.

bridge_agentstring required

The bridge agent name, version and website.

max_pixelsinteger

The maximum pixels in resolution this worker can generate.

megapixelsteps_generatednumber

How many megapixelsteps this worker has generated until now.

img2imgboolean

If True, this worker supports and allows img2img requests.

paintingboolean

If True, this worker supports and allows inpainting requests.

post-processingboolean

If True, this worker supports and allows post-processing requests.

loraboolean

If True, this worker supports and allows lora requests.

max_lengthinteger

The maximum tokens this worker can generate.

max_context_lengthinteger

The maximum tokens this worker can read.

tokens_generatednumber

How many tokens this worker has generated until now.

Example response

[
  {
    "type": "image",
    "info": "https://dbzer0.com",
    "owner": "username#1",
    "ipaddr": "username#1",
    "contact": "email@example.com",
    "bridge_agent": "AI Horde Worker reGen:4.1.0:https://github.com/Haidra-Org/horde-worker-reGen",
    "max_pixels": 262144,
    "max_length": 80,
    "max_context_length": 80
  }
]