Lookup user details based on their API key

This can be used to verify a user exists

get/v2/find_user

Request

Base URL
/api (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared
TypeScript
https://skmtc.dev/haidra-org/apis/ai-horde/docs/v2/find_user/get.ts
A function with typed inputs. Its response is checked against the schema.

Headers

apikeystring

User API key we're looking for.

Client-Agentstring

The client name and version.

X-Fieldsstring mask

An optional fields mask

Response

Worker Details

usernamestring

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

idinteger

The user unique ID. It is always an integer.

kudosnumber

The amount of Kudos this user has. The amount of Kudos determines the priority when requesting image generations.

evaluating_kudosnumber

(Privileged) The amount of Evaluating Kudos this untrusted user has from generations and uptime. When this number reaches a prespecified threshold, they automatically become trusted.

concurrencyinteger

How many concurrent generations this user may request.

worker_invitedinteger

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

moderatorboolean

This user is a AI Horde moderator.

worker_countinteger

How many workers this user has created (active or inactive).

worker_idsstring[]

sharedkey_idsstring[]

trustedboolean

This user is a trusted member of the AI Horde.

flaggedboolean

(Privileged) This user has been flagged for suspicious activity.

vpnboolean

(Privileged) This user has been given the VPN role.

serviceboolean

This is a service account used by a horde proxy.

educationboolean

This is an education account used schools and universities.

specialboolean

(Privileged) This user has been given the Special role.

suspiciousinteger

(Privileged) How much suspicion this user has accumulated.

pseudonymousboolean

If true, this user has not registered using an oauth service.

contactstring

(Privileged) Contact details for the horde admins to reach the user in case of emergency.

admin_commentstring

(Privileged) Information about this users by the admins

account_ageinteger

How many seconds since this account was created.

Example response

{
  "worker_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "sharedkey_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "contact": "email@example.com",
  "admin_comment": "User is sus",
  "account_age": 60
}

Changes

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