Skip to main content
AltText.ai logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: ALTTEXT_AI
  • Version: 20261101_00

Tools

Slug: ALTTEXT_AI_CREATE_BULK_IMAGESTool to bulk upload and process a CSV file of image URLs for alt text generation. Use when you need to process multiple images at once (up to 100,000 URLs). Invalid rows are returned in row_errors for debugging.

Input Parameters

object
required
CSV file containing image URLs to process. The CSV should have a ‘url’ column with image URLs. Maximum 100000 rows.
string
Optional email address to receive results of the bulk upload when processing is complete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTTEXT_AI_CREATE_IMAGETool to add an image and generate alt text. Supports both URL and base64-encoded file upload. Use when you need to generate alt text for images, with options for custom prompts, keywords, multiple languages, and ecommerce data. Rate limited to 4 calls per second.

Input Parameters

string
Language code(s) for alt text generation. Use comma-separated values for multiple languages (e.g., ‘en,es,fr’). Default is ‘en’.
object
Ecommerce data for product images.
object
required
Image data object containing URL or base64-encoded data. Either url or raw field must be provided.
array
Keywords or phrases for SEO-optimized alt text. Maximum 6 items.
integer
Maximum length of generated alt text. Must be between 80 and 500 characters.
boolean
Force regeneration of alt text for existing image. Default false.
boolean
Whether to add the image in the background. If true, returns immediately with processing status. Default false.
string
ChatGPT prompt to apply to generated alt text. Use {{AltText}} macro to reference the initial alt text.
string ("describe-detailed" | "describe-regular" | "describe-factual" | "succinct-describe-factual" | "describe-terse")
Available language models for alt text generation.
string
Alternative webhook URL for this operation to receive async notifications
integer
Maximum timeout in seconds for alt text generation. Must be between 5 and 30 seconds. Default is 12.
string
Text source for extracting keywords if keywords array is blank
array
Keywords to remove from generated alt text. Maximum 6 items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTTEXT_AI_DELETE_IMAGE_BY_ASSET_IDTool to delete an image from your library by its asset ID. Use when you need to remove a specific image permanently from your AltText.ai account.

Input Parameters

string
required
The asset ID of the image to delete from your library.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTTEXT_AI_GET_ACCOUNTTool to retrieve account settings and usage information. Use when you need to check your AltText.ai account configuration and usage limits before generating alt text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTTEXT_AI_GET_IMAGE_BY_ASSET_IDTool to retrieve detailed information about a specific image using its asset ID. Use when you need to fetch alt text, metadata, or status of a previously processed image.

Input Parameters

string
required
The unique asset ID of the image to retrieve. This is returned when creating or listing images.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTTEXT_AI_GET_IMAGESTool to retrieve a paginated list of images in your library, including their alt text and metadata. Use when you need to browse or filter images programmatically after authentication.

Input Parameters

string
Exact URL to filter images by. Must match the stored image URL exactly; no wildcards.
integer
Page number to retrieve, starting at 1.
integer
Number of images per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTTEXT_AI_SCRAPE_PAGEScrape a web page or HTML document and queue eligible images for asynchronous alt text generation; some images may be skipped. The scraper does not execute JavaScript and can include images with existing alt text.

Input Parameters

string
Language code(s) for alt text generation. Use comma-separated values for multiple languages (e.g., ‘en,es’).
array
Keywords for SEO-optimized alt text. Maximum 6 items. Must be in English.
object
required
Page scrape configuration containing URL or HTML to process.
boolean
If true, process images that already have alt text. Defaults to false if not specified.
array
Keywords to exclude from generated alt text. Maximum 6 items. Must be in English.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTTEXT_AI_SEARCH_IMAGESSearch for images in your AltText.ai library by keywords. Searches through your previously processed images to find matches based on URLs, alt text content, and metadata. Useful for finding specific images in large libraries. Returns paginated results with alt text and metadata. Note: This searches your own image library, not a public image database. Images must be added via the Create Image endpoint before they can be searched.

Input Parameters

integer
Page number for paginated results, starting at 1.
string
required
Search keywords or phrase to find images in your library. Searches against image URLs, alt text content, and associated metadata.
integer
Number of results to return per page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTTEXT_AI_UPDATE_ACCOUNTTool to update account settings (e.g., webhook_url, name). Use after confirming current account details to modify settings.

Input Parameters

object
required
Account settings to update, nested object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALTTEXT_AI_UPDATE_IMAGE_BY_ASSET_IDUpdate an existing image identified by its asset ID, including its asset ID, alt text, and metadata. The image URL cannot be updated with this tool.

Input Parameters

string
Language code(s) for the updated alt text.
object
required
Image data to update. Note: You cannot update the URL of an existing image.
string
required
The asset ID of the image to update.
boolean
Whether to overwrite existing alt text. Default false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not