Modify an existing Shared Key

patch/v2/sharedkeys/{sharedkey_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/sharedkeys/:sharedkey_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Headers

apikeystring required

User API key.

Client-Agentstring

The client name and version

X-Fieldsstring mask

An optional fields mask

Request body

kudosinteger

The Kudos limit assigned to this key. If -1, then anyone with this key can use an unlimited amount of kudos from this account.

expiryinteger

The amount of days after which this key will expire. If -1, this key will not expire.

namestring

A descriptive name for this key.

max_image_pixelsinteger

The maximum amount of image pixels this key can generate per job. -1 means unlimited.

max_image_stepsinteger

The maximum amount of image steps this key can use per job. -1 means unlimited.

max_text_tokensinteger

The maximum amount of text tokens this key can generate per job. -1 means unlimited.

Example request

{
  "expiry": 30,
  "name": "Mutual Aid"
}

Response

Shared Key Details

idstring

The SharedKey ID.

usernamestring

The owning user's unique Username. It is a combination of their chosen alias plus their ID.

namestring

The Shared Key Name.

kudosinteger

The Kudos limit assigned to this key.

expirystring date-time

The date at which this API key will expire.

utilizedinteger

How much kudos has been utilized via this shared key until now.