← Tools Reference

AltText.ai

AltText.ai integration (AI, Design & Media). Imported from open-connector.

API key7 toolshttps://alttext.ai/api/v1
GET
alt_text_ai_get_account
Retrieve AltText.ai account settings and usage details for the API key.

/account

POST
alt_text_ai_create_image
Add a publicly accessible image URL to AltText.ai and generate alt text.

/images

14 parameters
ParamTypeRequiredDescription
urlstringrequiredThe public URL of the image that needs alt text.
asset_idstringoptionalYour own unique asset ID for this image.
tagsarrayoptionalWords or phrases to associate with the image.
metadataobjectoptionalCustom key-value metadata associated with the image.
ecommobjectoptionalEcommerce product context for product image alt text generation.
keywordsarrayoptionalKeywords or phrases to consider when generating SEO-optimized alt text.
negative_keywordsarrayoptionalKeywords or phrases to consider when generating SEO-optimized alt text.
keyword_sourcestringoptionalText source for extracting keywords when keywords is blank.
langstringoptionalLanguage code or comma-separated language codes for generated alt text.
max_charsintegeroptionalMaximum generated alt text length in characters.
overwritebooleanoptionalWhether to regenerate existing alt text for the image.
gpt_promptstringoptionalPrompt to apply to generated alt text using the {{AltText}} macro.
model_namestringoptionalThe language model style to use for alt text generation.
timeout_secsintegeroptionalMaximum timeout in seconds for synchronous generation.
GET
alt_text_ai_list_images
List image records in the AltText.ai library with optional URL filtering.

/images

3 parameters
ParamTypeRequiredDescription
pageintegeroptionalPage number to retrieve, starting at 1.
limitintegeroptionalNumber of images per page, up to 100.
urlstringoptionalExact image URL used to filter results.
GET
alt_text_ai_get_image
Retrieve a single AltText.ai image record by asset ID.

/images/{asset_id}

1 parameter
ParamTypeRequiredDescription
asset_idstringrequiredThe unique asset ID of the image to retrieve.
GET
alt_text_ai_search_images
Search the AltText.ai image library by URL, asset ID, or alt text content.

/images/search

3 parameters
ParamTypeRequiredDescription
querystringrequiredThe search query for URL, asset ID, or alt text content.
pageintegeroptionalPage number to retrieve, starting at 1.
limitintegeroptionalNumber of search results per page, up to 100.
DELETE
alt_text_ai_delete_image
Delete an image from the AltText.ai library by asset ID.

/images/{asset_id}

1 parameter
ParamTypeRequiredDescription
asset_idstringrequiredThe asset ID of the image to delete.
POST
alt_text_ai_scrape_page
Scrape a web page or raw HTML document and queue discovered images for alt text generation.

/images/page_scrape

6 parameters
ParamTypeRequiredDescription
urlstringoptionalThe page URL to scrape. The crawler does not execute JavaScript.
htmlstringoptionalRaw HTML document to parse for image elements.
keywordsarrayoptionalKeywords or phrases to consider when generating SEO-optimized alt text.
negative_keywordsarrayoptionalKeywords or phrases to consider when generating SEO-optimized alt text.
langstringoptionalLanguage code or comma-separated language codes for generated alt text.
include_existingbooleanoptionalWhether to process images that already have alt text.