Docs
Open Lodol
DocumentationIntegrationsAPI

AltText.ai

App · Images & Design · 10 actions

Write accessible, SEO-friendly alt text for images in 130+ languages: for one image, a whole web page or thousands of links at once, with your keywords and product details. Look up, search, correct and delete alt text in your AltText.ai library.

Actions

ActionWhat it does
Delete an imageRemove an image and its alt text from your AltText.ai library.
Generate alt textWrite alt text for an image and save it to your AltText.ai library.
Generate alt text for a web pageFind every image on a web page and write alt text for each one that has none, saving it to your AltText.ai library.
Generate alt text for many imagesSend up to 100,000 image links to AltText.ai at once.
Get account detailsGet your AltText.ai plan, how many credits are left this billing period, and where notices are sent.
Get an image's alt textLook up an image in your AltText.ai library by its asset ID or its link.
List imagesList the images in your AltText.ai library with their alt text.
Search imagesFind images in your AltText.ai library by words in their alt text, part of their link, or their asset ID.
Update account settingsChange your AltText.ai account's name, the email that gets notices such as low credit, or the web address told about new and deleted images.
Update alt textReplace an image's alt text in your AltText.ai library with your own wording.

Delete an image

Remove an image and its alt text from your AltText.ai library. An image that is already gone is not an error: 'deleted' comes back false.

Inputs

ImageimagetextRequired
Pick an image from your AltText.ai library, or give its asset ID or its link.

Outputs

asset_idtext
The deleted image's asset ID.
deletedtrue/false
Whether an image was deleted.
image_urltext
The deleted image's link.
Example output
{
  "asset_id": "ea9edd7e217cf2805a803c23c2517b68",
  "deleted": true,
  "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/63/Monarch_In_May.jpg"
}

Generate alt text

Write alt text for an image and save it to your AltText.ai library. Uses one credit (two for AVIF, HEIC, SVG and TIFF images); an image link already in your library comes back free with its saved alt text.

Inputs

ImageimagetextRequired
The image to describe: upload a file, pick an image from an earlier step, or paste a link to one. JPEG, PNG, GIF, WebP and BMP all work, up to 16 MB.
Languagelanguagetext
The language to write the alt text in. Leave empty for your account's default language.One of: af (Afrikaans), sq (Albanian), am (Amharic), ar (Arabic), hy (Armenian), as (Assamese), ay (Aymara), az (Azerbaijani), bm (Bambara), eu (Basque), and 126 more.
Writing stylewriting_styletext
How much detail the alt text has, from Elaborated (the most) to Terse (usually under 120 characters). Leave empty for your account's default.One of: describe-detailed (Elaborated), describe-regular (Standard), describe-factual (Matter-of-fact), succinct-describe-factual (Concise), describe-terse (Terse).
Maximum lengthmax_lengthnumber
The longest the alt text may be, from 80 to 500 characters. Leave empty for your account's default.From 80 to 500.
SEO keywordskeywordslist
Up to 6 words or phrases to work into the alt text for search engines, in English. One or two are usually used.
Words to leave outnegative_keywordslist
Up to 6 words or phrases the alt text must not contain, in English.
Contextcontexttext
Text about the image, such as a product description or the paragraph it appears in. AltText.ai picks keywords from it when SEO keywords is empty.
Product nameproduct_nametext
For a product photo: the product's name, which is worked into the alt text.
Brandbrandtext
For a product photo: the product's brand.
Colorcolortext
For a product photo: the product's color.
Rewrite instructionsrewrite_instructionstext
Optional instructions for ChatGPT to rewrite the alt text, in English, such as 'Rewrite this in a warm, friendly tone.' ChatGPT sees only the alt text, not the image.
Asset IDasset_idtext
Your own ID for the image, such as a product SKU, to find or update it by later. Leave empty for AltText.ai to make one.
Replace existing alt textreplace_existingtrue/false
When the image is already in your library, write new alt text instead of returning the saved alt text. Uses a credit.Default: false.

Outputs

already_in_librarytrue/false
True when the image was already in your library, so its saved alt text came back rather than new alt text.
alt_texttext
The image's alt text.
alt_textsobject
The alt text in every language the image has, by language code (en, es, fr, ...).
asset_idtext
The image's ID in your AltText.ai library.
created_attext
When the image was added to the library (UTC).
image_urltext
The image's link. Empty for an uploaded file.
languagetext
The language code the alt text was asked for. Empty for your account's default.
Example output
{
  "already_in_library": false,
  "alt_text": "A monarch butterfly resting on a pink flower.",
  "alt_texts": {
    "en": "A monarch butterfly resting on a pink flower."
  },
  "asset_id": "ea9edd7e217cf2805a803c23c2517b68",
  "created_at": "2026-09-24T09:21:16Z",
  "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/63/Monarch_In_May.jpg",
  "language": ""
}

Generate alt text for a web page

Find every image on a web page and write alt text for each one that has none, saving it to your AltText.ai library. The alt text that is ready within about 30 seconds comes back with the step; the rest lands in your library shortly after. Uses one credit per new image.

Inputs

Web pagepagetextRequired
A link to the page, or the page's HTML. Only images in the page's HTML are found, not ones added by scripts.
Include images that have alt textinclude_images_with_alt_texttrue/false
Also write new alt text for images that already have some on the page.Default: false.
Languagelanguagetext
The language to write the alt text in. Leave empty for your account's default language.One of: af (Afrikaans), sq (Albanian), am (Amharic), ar (Arabic), hy (Armenian), as (Assamese), ay (Aymara), az (Azerbaijani), bm (Bambara), eu (Basque), and 126 more.
SEO keywordskeywordslist
Up to 6 words or phrases to work into the alt text for search engines, in English. One or two are usually used.
Words to leave outnegative_keywordslist
Up to 6 words or phrases the alt text must not contain, in English.

Outputs

found_countnumber
How many images the page has.
imageslist
Every image found, in page order.
page_urltext
The page's link. Empty when HTML was given.
queued_countnumber
How many are getting new alt text.
ready_countnumber
How many new alt texts came back with the step.
Example output
{
  "found_count": 1,
  "images": [
    {
      "alt_text": "A blue longboard leaning against a beach hut.",
      "asset_id": "a1b2c3d4e5f6",
      "existing_alt_text": "",
      "height": 480,
      "image_url": "https://www.harborsurf.com/images/longboard.jpg",
      "queued": true,
      "skip_reason": "",
      "width": 640
    }
  ],
  "page_url": "https://www.harborsurf.com/boards",
  "queued_count": 1,
  "ready_count": 1
}

Generate alt text for many images

Send up to 100,000 image links to AltText.ai at once. Alt text is written in the background and saved to your library; read it with 'Get an image's alt text' or 'List images'. Uses one credit per new image.

Inputs

ImagesimageslistRequired
One image link per entry, or rows from an earlier step with an image link in a url or image_url column. Rows may also have asset_id, product_name, brand, context and language columns.
Languagelanguagetext
The language to write the alt text in. Leave empty for your account's default language.One of: af (Afrikaans), sq (Albanian), am (Amharic), ar (Arabic), hy (Armenian), as (Assamese), ay (Aymara), az (Azerbaijani), bm (Bambara), eu (Basque), and 126 more.
Rewrite instructionsrewrite_instructionstext
Optional instructions for ChatGPT to rewrite the alt text, in English, such as 'Rewrite this in a warm, friendly tone.' ChatGPT sees only the alt text, not the image.
Email when finishedemailtext
An email address AltText.ai tells when every image is done.

Outputs

accepted_countnumber
How many AltText.ai is writing alt text for.
problem_countnumber
How many AltText.ai turned away.
problemslist
The images AltText.ai turned away, and why.
submitted_countnumber
How many images were sent.
Example output
{
  "accepted_count": 3,
  "problem_count": 0,
  "problems": [],
  "submitted_count": 3
}

Get account details

Get your AltText.ai plan, how many credits are left this billing period, and where notices are sent.

Inputs

None.

Outputs

account_nametext
The account's name.
alert_emailtext
Where AltText.ai emails notices such as low credit.
credit_limitnumber
Credits available this billing period, including any rolled over.
credits_remainingnumber
Credits left this billing period.
credits_usednumber
Credits used this billing period.
notification_urltext
The web address AltText.ai tells when images are added or deleted.
plantext
The plan's name. Empty when there is no plan.
plan_statustext
Whether the plan is active, such as 'active'.
renews_attext
When the plan renews or ends.
Example output
{
  "account_name": "Harbor Surf Co.",
  "alert_email": "alerts@harborsurf.com",
  "credit_limit": 100,
  "credits_remaining": 77,
  "credits_used": 23,
  "notification_url": "",
  "plan": "Bronze Plan (Monthly)",
  "plan_status": "active",
  "renews_at": "2026-10-23T13:48:07.465Z"
}

Get an image's alt text

Look up an image in your AltText.ai library by its asset ID or its link. An image that is not there is not an error: 'found' comes back false.

Inputs

ImageimagetextRequired
Pick an image from your AltText.ai library, or give its asset ID or its link.

Outputs

alt_texttext
The image's alt text.
alt_textsobject
The alt text in every language the image has, by language code (en, es, fr, ...).
asset_idtext
The image's ID in your AltText.ai library.
created_attext
When the image was added to the library (UTC).
foundtrue/false
Whether the image is in your library.
image_urltext
The image's link. Empty for an uploaded file.
Example output
{
  "alt_text": "A monarch butterfly resting on a pink flower.",
  "alt_texts": {
    "en": "A monarch butterfly resting on a pink flower."
  },
  "asset_id": "ea9edd7e217cf2805a803c23c2517b68",
  "created_at": "2026-09-24T09:21:16Z",
  "found": true,
  "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/63/Monarch_In_May.jpg"
}

List images

List the images in your AltText.ai library with their alt text.

Inputs

Most resultsmax_resultsnumber
The most images to return, up to 1,000. Leave empty for 20.From 1 to 1000.

Outputs

countnumber
How many images came back.
imageslist
The images, each with its alt text.
total_countnumber
How many images match in all.
Example output
{
  "count": 1,
  "images": [
    {
      "alt_text": "A monarch butterfly resting on a pink flower.",
      "alt_texts": {
        "en": "A monarch butterfly resting on a pink flower."
      },
      "asset_id": "ea9edd7e217cf2805a803c23c2517b68",
      "created_at": "2026-09-24T09:21:16Z",
      "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/63/Monarch_In_May.jpg"
    }
  ],
  "total_count": 1
}

Search images

Find images in your AltText.ai library by words in their alt text, part of their link, or their asset ID.

Inputs

Search forquerytextRequired
Words in the alt text, such as 'butterfly'. Use & for both words, | for either, and - to leave a word out ('apple -banana'). A link starting with https:// finds images whose link contains it.
Most resultsmax_resultsnumber
The most images to return, up to 1,000. Leave empty for 20.From 1 to 1000.

Outputs

countnumber
How many images came back.
imageslist
The images, each with its alt text.
total_countnumber
How many images match in all.
Example output
{
  "count": 1,
  "images": [
    {
      "alt_text": "A monarch butterfly resting on a pink flower.",
      "alt_texts": {
        "en": "A monarch butterfly resting on a pink flower."
      },
      "asset_id": "ea9edd7e217cf2805a803c23c2517b68",
      "created_at": "2026-09-24T09:21:16Z",
      "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/63/Monarch_In_May.jpg"
    }
  ],
  "total_count": 1
}

Update account settings

Change your AltText.ai account's name, the email that gets notices such as low credit, or the web address told about new and deleted images. Fields left empty stay as they are.

Inputs

Account nameaccount_nametext
The account's new name.
Alert emailalert_emailtext
The email address AltText.ai sends important notices to, such as a low credit balance.
Notification URLnotification_urltext
A web address AltText.ai sends each image to when it is added to or deleted from your library, such as a webhook trigger's link.

Outputs

account_nametext
The account's name.
alert_emailtext
Where AltText.ai emails notices such as low credit.
credit_limitnumber
Credits available this billing period, including any rolled over.
credits_remainingnumber
Credits left this billing period.
credits_usednumber
Credits used this billing period.
notification_urltext
The web address AltText.ai tells when images are added or deleted.
plantext
The plan's name. Empty when there is no plan.
plan_statustext
Whether the plan is active, such as 'active'.
renews_attext
When the plan renews or ends.
Example output
{
  "account_name": "Harbor Surf Co.",
  "alert_email": "alerts@harborsurf.com",
  "credit_limit": 100,
  "credits_remaining": 77,
  "credits_used": 23,
  "notification_url": "",
  "plan": "Bronze Plan (Monthly)",
  "plan_status": "active",
  "renews_at": "2026-10-23T13:48:07.465Z"
}

Update alt text

Replace an image's alt text in your AltText.ai library with your own wording.

Inputs

ImageimagetextRequired
Pick an image from your AltText.ai library, or give its asset ID or its link.
Alt textalt_texttextRequired
The new alt text, up to 1,024 characters.
Languagelanguagetext
The language the new alt text is in. Leave empty to replace the image's main alt text.One of: af (Afrikaans), sq (Albanian), am (Amharic), ar (Arabic), hy (Armenian), as (Assamese), ay (Aymara), az (Azerbaijani), bm (Bambara), eu (Basque), and 126 more.

Outputs

alt_texttext
The image's alt text.
alt_textsobject
The alt text in every language the image has, by language code (en, es, fr, ...).
asset_idtext
The image's ID in your AltText.ai library.
created_attext
When the image was added to the library (UTC).
image_urltext
The image's link. Empty for an uploaded file.
Example output
{
  "alt_text": "A monarch butterfly resting on a pink flower.",
  "alt_texts": {
    "en": "A monarch butterfly resting on a pink flower."
  },
  "asset_id": "ea9edd7e217cf2805a803c23c2517b68",
  "created_at": "2026-09-24T09:21:16Z",
  "image_url": "https://upload.wikimedia.org/wikipedia/commons/6/63/Monarch_In_May.jpg"
}

Algolia

Previous Page

Amazon AppConfig

Next Page

On this page

ActionsDelete an imageGenerate alt textGenerate alt text for a web pageGenerate alt text for many imagesGet account detailsGet an image's alt textList imagesSearch imagesUpdate account settingsUpdate alt text