Get details about an existing Shared Key

get/v2/sharedkeys/{sharedkey_id}

Headers

Client-Agentstring

The client name and version.

X-Fieldsstring mask

An optional fields mask

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.

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.

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