AltTextify icon

AltTextify

Generate alt text using AltTextify API

Overview

This node, named "AltTextify," generates descriptive alternative text (alt text) for images by leveraging the AltTextify API. It is designed to help users automatically create meaningful and SEO-optimized alt text for images provided via public URLs. This is particularly useful for improving web accessibility and enhancing search engine optimization by providing relevant descriptions of images.

Common scenarios include:

  • Automatically generating alt text for product images in e-commerce platforms.
  • Creating descriptive alt text for blog or news article images to improve accessibility.
  • Enhancing SEO by including keywords and product/brand information in alt text.

For example, an e-commerce store owner can input a product image URL along with product and brand names plus SEO keywords, and the node will return optimized alt text suitable for use on their website.

Properties

Name Meaning
Image URL A publicly accessible URL of the image in JPEG, PNG, GIF, WEBP, or BMP format to generate alt text for.
Language The language code (ISO 639-1) for the alt text output. Defaults to English ("en"). Examples: "pt", "de".
Keywords Comma-separated list of English keywords or phrases to optimize the alt text for SEO. Only one or two are used per alt text but all are considered.
Product Name [Ecommerce] The name of the product to be included in the generated alt text (useful for e-commerce images).
Brand Name [Ecommerce] The brand name to be included in the generated alt text (useful for e-commerce images).

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.

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.
    • 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 API requests.
  • Error messages:

    • Errors returned from the API will appear in the output JSON under the error field.
    • Typical errors may include authentication failures, invalid parameters, or rate limiting.
  • Resolution tips:

    • Double-check all input parameters for correctness.
    • Confirm the API key is active and has sufficient permissions.
    • Retry after some time if rate limits are exceeded.

Links and References

Discussion