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 predefined templates. It is particularly useful for automating image creation workflows where dynamic content or design changes are needed, such as generating marketing materials, personalized graphics, QR codes, or customized shapes within an image template.

Typical use cases include:

  • Creating branded images by applying text or image changes to a template.
  • Generating QR codes embedded in images dynamically.
  • Modifying shapes and colors within a template for visual customization.
  • Waiting for the rendering process to complete before proceeding, or receiving webhook notifications when the image is ready.

Properties

Name Meaning
Template ID The identifier of the image template to use for generation.
Changes A collection of modifications to apply to the template elements. Each change specifies:
- Change Type: Text, Image, QR Code, or Shape (Rect/Triangle/Circle).
- Element Name: The target element to modify.
- Additional fields depending on type:
- Text: text content, fill color, stroke color, text background color.
- Image: image URL, stroke color.
- QR Code: content to encode, fill color, stroke color.
- Shape: fill color, stroke color.
Additional Options Optional settings affecting output and processing:
- Format: Output image format, either PNG or JPG.
- Wait for Completion: Whether to wait until rendering finishes before returning.
- Max Wait Time (Seconds): Maximum time to wait for rendering completion.
- Polling Interval (Seconds): Frequency to check rendering status.
- Webhook URL: URL to receive a webhook notification when the image is ready.

Output

The node outputs JSON data containing the response from the Copicake API:

  • When creating an image, the output includes details about the rendering job, including a unique rendering ID and status.
  • If waiting for completion is enabled, the node polls the API until the image rendering is successful or failed, then returns the final rendering status and metadata.
  • The JSON may contain URLs or identifiers to access the generated image.
  • Binary data is not directly output by this node; instead, it provides metadata and links to the generated image.

Dependencies

  • Requires an API key credential for authenticating with the Copicake API.
  • Network access to https://api.copicake.com is necessary.
  • Optional webhook URL can be configured to receive asynchronous notifications when image rendering completes.

Troubleshooting

  • Timeouts waiting for rendering completion: If the image takes longer than the specified max wait time, the node will stop polling and return the current status. Increase the max wait time or disable waiting to handle asynchronously.
  • Invalid template ID or element names: Ensure the template ID exists and element names match those defined in the template; otherwise, the API may return errors or ignore changes.
  • Malformed color codes or URLs: Colors must be in hex format (e.g., #ff0000). Invalid URLs for images or webhooks may cause failures.
  • API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Webhook URL issues: If using webhook notifications, ensure the URL is publicly accessible and can accept POST requests from the Copicake service.

Common error messages typically relate to invalid parameters or authentication failures and can be resolved by verifying input values and credentials.

Links and References

Discussion