Sign in

v1

latestSwagger 2.02026-07-176096209.1 KB
v2

Endpoint for horde admins to perform operations on users

put/v2/users/{user_id}

Headers

apikeystring required

The Admin API .

Client-Agentstring

The client name and version.

X-Fieldsstring mask

An optional fields mask

Request body

kudosnumber

The amount of kudos to modify (can be negative).

concurrencyinteger

The amount of concurrent request this user can have.

usage_multipliernumber

The amount by which to multiply the users kudos consumption.

worker_invitedinteger

Set to the amount of workers this user is allowed to join to the horde when in worker invite-only mode.

moderatorboolean

Set to true to make this user a horde moderator.

public_workersboolean

Set to true to make this user display their worker IDs.

monthly_kudosinteger

When specified, will start assigning the user monthly kudos, starting now!

usernamestring

When specified, will change the username. No profanity allowed!

trustedboolean

When set to true,the user and their servers will not be affected by suspicion.

flaggedboolean

When set to true, the user cannot tranfer kudos and all their workers are put into permanent maintenance.

customizerboolean

When set to true, the user will be able to serve custom Stable Diffusion models which do not exist in the Official AI Horde Model Reference.

vpnboolean

When set to true, the user will be able to onboard workers behind a VPN. This should be used as a temporary solution until the user is trusted.

serviceboolean

When set to true, the user is considered a service account proxying the requests for other users.

educationboolean

When set to true, the user is considered an education account and some options become more restrictive.

specialboolean

When set to true, The user can send special payloads.

filteredboolean

When set to true, the replacement filter will always be applied against this user

reset_suspicionboolean

Set the user's suspicion back to 0.

contactstring

Contact details for the horde admins to reach the user in case of emergency. This is only visible to horde moderators.

admin_commentstring

Add further information about this user for the other admins.

Example request

{
  "contact": "email@example.com",
  "admin_comment": "User is sus"
}

Response

Modify User

new_kudosnumber

The new total Kudos this user has after this request.

concurrencyinteger

The request concurrency this user has after this request.

usage_multipliernumber

Multiplies the amount of kudos lost when generating images.

worker_invitedinteger

Whether this user has been invited to join a worker to the horde and how many of them. When 0, this user cannot add (new) workers to the horde.

moderatorboolean

The user's new moderator status.

public_workersboolean

The user's new public_workers status.

usernamestring

The user's new username.

monthly_kudosinteger

The user's new monthly kudos total.

trustedboolean

The user's new trusted status.

flaggedboolean

The user's new flagged status.

customizerboolean

The user's new customizer status.

vpnboolean

The user's new vpn status.

serviceboolean

The user's new service status.

educationboolean

The user's new education status.

specialboolean

The user's new special status.

new_suspicioninteger

The user's new suspiciousness rating.

contactstring

The new contact details.

admin_commentstring

The new admin comment.

Example response

{
  "concurrency": 30,
  "usage_multiplier": 1,
  "worker_invited": 1,
  "username": "username#1",
  "contact": "email@example.com",
  "admin_comment": "User is sus"
}