PUT /v2/workers/{worker_id}

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/workers/:worker_id/put.ts
A function with typed inputs. Its response is checked against the schema.

Headers

apikeystring required

The Moderator or Owner API key.

Client-Agentstring

The client name and version.

X-Fieldsstring mask

An optional fields mask

Request body

maintenanceboolean

Set to true to put this worker into maintenance.

maintenance_msgstring

if maintenance is True, you can optionally provide a message to be used instead of the default maintenance message, so that the owner is informed.

pausedboolean

(Mods only) Set to true to pause this worker.

infostring

You can optionally provide a server note which will be seen in the server details. No profanity allowed!

namestring

When this is set, it will change the worker's name. No profanity allowed!

teamstring

The team towards which this worker contributes kudos. It an empty string ('') is passed, it will leave the worker without a team. No profanity allowed!

Example request

{
  "team": "0bed257b-e57c-4327-ac64-40cdfb1ac5e6"
}

Response

Modify Worker

maintenanceboolean

The new state of the 'maintenance' var for this worker. When True, this worker will not pick up any new requests.

pausedboolean

The new state of the 'paused' var for this worker. When True, this worker will not be given any new requests.

infostring

The new state of the 'info' var for this worker.

namestring

The new name for this this worker.

teamstring

The new team of this worker.

Example response

{
  "team": "Direct Action"
}

Changes

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