---
title: "GET /account"
method: GET
path: "/account"
tags: ["Account"]
---

# GET /account

`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`

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`.

## Response `200`

Successful retrieval of the account data.

- Account
  - `name` string: The name of your account.
  - `webhook_url` string: [optional] The notification URL to use for webhooks.
  - `notification_email` string: [optional] The email address to notify for important transactional events, such as low credit balance.
  - `usage` integer: The number of credits used this billing period.
  - `usage_limit` integer: The maximum number of credits that can be used during this billing period (includes any rollover credits).
  - `whitelabel` boolean: 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_period` boolean: 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_quotes` boolean: 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_symbols` string[]: A list of symbol characters which should be removed from the generated alt text.
  - `gpt_prompt` string: 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_chars` integer: 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.
  - `api_key` CallingApiKey: The key that made this request.
    - `kind` 'site' | 'full_access': `full_access` keys can manage API keys; `site` keys cannot.
    - `can_manage_keys` boolean: Whether this key can call the API Keys endpoints. An assistant connection can manage keys when it was granted the Manage API keys permission.
    - `name` string: The name of the key.
    - `origin` string: Where the key was created, for example `dashboard`, `api` or `shopify`.
  - `subscription` Subscription
    - `plan_name` string: The name of your current subscription plan.
    - `usage_quota` integer: The number of credits granted each billing period on this plan.
    - `status` string: The current status of the subscription plan.
    - `expires_at` string: The renewal / expiration date of the plan.
  - `errors` object: Any errors associated with the account. Note - This will be an empty object for valid account data.

## Other responses

- `403`: The `X-API-Key` header is missing or not valid. `error_code` is `invalid_api_key` for an unknown key and `api_key_revoked` for a revoked one.

---

[API](https://skmtc.dev/alttext/apis/alttext-ai-api.md) · [All operations](https://skmtc.dev/alttext/apis/alttext-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/alttext/apis/alttext-ai-api/revisions/6eb62e8e450c?raw)