AltTextify icon

AltTextify

Generate alt text using AltTextify API

Overview

This node, named "AltTextify," generates descriptive alternative (alt) text for images using the AltTextify API. It is designed to help users automatically create meaningful alt text that improves accessibility and SEO for images on websites or ecommerce platforms.

Common scenarios where this node is beneficial include:

  • Automatically generating alt text for product images in online stores to enhance SEO and user experience.
  • Creating descriptive alt text for images in content management systems to improve accessibility compliance.
  • Generating multilingual alt text by specifying language codes, useful for internationalized websites.

For example, an ecommerce site can input a product image URL along with the product and brand names, and receive optimized alt text that includes relevant keywords and descriptions tailored to the specified language.

Properties

Name Meaning
Image URL Provide a publicly accessible image URL in JPEG, PNG, GIF, WEBP, or BMP format.
Language Language code for the alt text output. Defaults to English (en). Accepts ISO 639-1 codes like pt, de.
Keywords List of keywords/phrases for SEO-optimized alt text. Only one or two will be used per alt text, but all are considered. Must be in English even if alt text is in another language.
Product Name [Ecommerce] Product name to be included in the final alt text (useful for ecommerce product images).
Brand Name [Ecommerce] Brand name to be included in the final alt text (useful for ecommerce product images).

Output

The node outputs JSON data containing the generated alt text returned from the AltTextify API. The structure is:

{
  "alt_text": "string"
}

If an error occurs during processing, the output JSON will contain an error field with the error message, e.g.:

{
  "error": "Error message here"
}

The node does not output binary data.

Dependencies

  • Requires an API key credential for the AltTextify API.
  • The node makes HTTP POST requests to https://api.alttextify.net/api/v1/image/url.
  • The image URL must be publicly accessible.
  • No additional environment variables or configurations are required beyond the API key credential.

Troubleshooting

  • Common issues:

    • Invalid or inaccessible image URL: Ensure the image URL is publicly accessible and points to a supported image format (JPEG, PNG, GIF, WEBP, BMP).
    • Missing or invalid API key: Verify that the API key credential is correctly configured and valid.
    • Network connectivity problems: Check internet connection and firewall settings that might block access to the AltTextify API endpoint.
  • Common error messages:

    • "Invalid API key": Check and update the API key credential.
    • "Image URL not accessible": Confirm the image URL is correct and publicly reachable.
    • "Unsupported image format": Use one of the supported formats listed above.

Resolving these typically involves verifying input parameters and credentials.

Links and References

Discussion