Account

Get account settings. The response includes an api_key object describing the key that made the request: its kind, name, origin, and whether it can_manage_keys.

get/account

Request

  • Base URL: https://alttext.ai/api/v1
  • URL: https://alttext.ai/api/v1/account
  • Auth: API key in header X-API-Key

Response

Successful retrieval of the account data.

namestring

The name of your account.

webhook_urlstring

[optional] The notification URL to use for webhooks.

notification_emailstring

[optional] The email address to notify for important transactional events, such as low credit balance.

usageinteger

The number of credits used this billing period.

usage_limitinteger

The maximum number of credits that can be used during this billing period (includes any rollover credits).

whitelabelboolean

Whether this account is marked as being a whitelabel account. When whitelabel is true, integrations for this account (e.g. WordPress, Shopify, etc) will not display the plan name being used. This is useful if you are installing AltText.ai on behalf of other clients who do not need to know your plan details. You can update this setting only on the AltText.ai website.

ending_periodboolean

Whether to add a period to the end of each generated alt text. This setting can only be updated on the AltText.ai website.

no_quotesboolean

Whether to remove single and double quote characters from the generated alt text. This setting can only be updated on the AltText.ai website.

remove_symbolsstring[]

A list of symbol characters which should be removed from the generated alt text.

gpt_promptstring

The default Final Pass prompt: a prompt of your own that runs on each alt text after it is generated. Prompts must be written in English, even if alt text is being generated in another language.

max_charsinteger

Maximum character limit for alt text, if set on the account. A value of null means alt text will be generated using the default limits of the AI model.

errorsobject

Any errors associated with the account. Note - This will be an empty object for valid account data.

Changes

No recorded changes to this operation across all 1 revision of this API.