Copicake icon

Copicake

Generate and retrieve images using Copicake API
Join our community

Actions2

Overview

This node integrates with the Copicake API to generate and retrieve images based on templates. It supports two main operations under the "Image" resource:

  • Create: Generate a new image by applying specified changes to a chosen template. This is useful for dynamically customizing images, such as adding text, QR codes, shapes, or replacing elements with other images.
  • Get: Retrieve an existing generated image using its rendering ID. This allows users to fetch the status or final output of previously created images.

Common scenarios include automated image generation for marketing materials, personalized graphics, or dynamic content creation workflows where images need to be programmatically customized and retrieved.

Properties

Name Meaning
Rendering ID The unique rendering ID of the image to retrieve.

(Note: Only the "Get" operation properties are listed here as requested.)

Output

The node outputs JSON data representing the response from the Copicake API for the requested image. For the "Get" operation, this typically includes details about the image rendering status, metadata, and URLs to access the generated image.

If the image is still processing, the status will reflect that; if completed, the output will contain the final image information.

The node does not output binary data directly but provides URLs or references to the generated images in the JSON response.

Dependencies

  • Requires an API key credential for authenticating with the Copicake API.
  • Network access to https://api.copicake.com is necessary.
  • No additional environment variables or configurations beyond the API credential are required.

Troubleshooting

  • Common issues:

    • Invalid or missing rendering ID will cause the API request to fail.
    • Network connectivity problems can prevent successful API calls.
    • If the image rendering is not yet complete, the returned status will indicate processing; users should wait or poll again later.

  • Error messages:

    • Errors from the API (e.g., invalid ID) are returned in the JSON error field.
    • If the node encounters an error and "Continue On Fail" is enabled, it returns the error message in the output JSON for that item.
    • To resolve errors, verify the rendering ID correctness and ensure the API key is valid and has proper permissions.

Links and References

Discussion