0CodeKit icon

0CodeKit

A toolbox of no-code utilities

Actions108

Overview

The node provides a versatile set of no-code utilities grouped by resource and operation categories. Specifically, for the Image resource with the Overlay operation, it overlays one image on top of another. This is useful in scenarios such as watermarking images, combining logos with backgrounds, or creating composite images dynamically.

For example, you might overlay a company logo (front image) onto a product photo (back image) to create branded marketing materials automatically within your workflow.

Properties

Name Meaning
Code Variables A collection of code variables defined in the code editor that can be used as dynamic inputs for the selected function.
Front Image URL URL of the front image that will be overlaid on top of the back image.
Back Image URL URL of the back image which serves as the background for the overlay.
Position Position where the front image will be placed over the back image. Default is "center".
Options Overlay JSON object specifying options for the overlay operation, e.g., opacity level. Default is {"opacity":0.6}.
File Name Optional filename for the image being operated on.
Get File as URL Boolean indicating whether to return the resulting image as a URL (true) or as raw data (false).

Output

The output is a JSON array containing the results of the overlay operation. Each item typically includes the processed image data or a URL pointing to the resulting image, depending on the "Get File as URL" property.

If binary data is returned, it represents the image file after the overlay operation has been applied.

Dependencies

  • Requires an API key credential for authentication with the external service providing the image processing capabilities.
  • The node makes HTTP POST requests to endpoints structured as /image/overlay with parameters including URLs of images and overlay options.
  • No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

  • Common issues:

    • Invalid or inaccessible image URLs may cause the overlay operation to fail.
    • Incorrect JSON format in the "Options Overlay" property can lead to errors.
    • Missing required properties like "Front Image URL" or "Back Image URL" will prevent execution.
  • Error messages:

    • Errors related to network or authorization failures indicate problems with the API key or connectivity.
    • Parsing errors suggest malformed JSON input in options or code variables.
  • Resolutions:

    • Verify that image URLs are publicly accessible and correctly formatted.
    • Ensure the "Options Overlay" JSON is valid.
    • Confirm the API key credential is configured properly in n8n.

Links and References

Discussion