AltTextify icon

AltTextify

Generate alt text using AltTextify API
Join our community

Actions2

Overview

This node, named "AltTextify," generates descriptive alternative (alt) text for images by leveraging the AltTextify API. It is particularly useful for improving web accessibility and SEO by automatically creating meaningful alt text for images based on their content. Typical use cases include e-commerce platforms that want to enhance product image descriptions, content management systems aiming to improve SEO, or any automation workflow requiring image description generation.

For example, an online store can input a product image URL along with product and brand names to generate optimized alt text that improves search engine visibility and assists visually impaired users.

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 such as pt (Portuguese), de (German), etc.
Keywords List of keywords or phrases for SEO-optimized alt text. Only one or two will be used per alt text, but all are considered. Keywords must be in English even if the alt text is generated in another language.
Product Name [Ecommerce] Product name to be included in the final alt text (useful for e-commerce scenarios).
Brand Name [Ecommerce] Brand name to be included in the final alt text (useful for e-commerce scenarios).

Output

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

{
  "alt_text": "Generated descriptive alt text string"
}

If an error occurs during processing, the output JSON will contain an error field with the error message, for example:

{
  "error": "Error message describing what went wrong"
}

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 provided 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: Confirm that the n8n instance can reach the AltTextify API endpoint.
    • Incorrect language codes: Use valid ISO 639-1 language codes; otherwise, the API may default to English or return an error.

  • Error messages:

    • Errors returned from the API will appear in the output under the error field.
    • Common error messages might relate to authentication failures, invalid parameters, or rate limiting.

To resolve errors:

  • Double-check the API key and permissions.
  • Validate all input parameters, especially the image URL and language code.
  • Review API usage limits and ensure you have not exceeded them.

Links and References

Discussion