bookoly icon

bookoly

Interact with the bookoly API

Overview

The node integrates with the Bookoly API to add a watermark image onto a video. It is useful for branding videos by overlaying logos or other images at specific positions on the video frame. Typical use cases include adding company logos, copyright marks, or promotional badges to marketing videos, tutorials, or user-generated content.

For example, you can provide a publicly accessible video URL and an image URL of your logo, specify the position coordinates, and the node will generate a new video with the watermark applied.

Properties

Name Meaning
Name The name to assign to the video being processed.
Video URL Public and downloadable URL of the source video file to which the watermark will be added.
Mute Video Whether to mute the original audio track of the video (true/false).
Watermark - URL Public and downloadable URL of the image file (e.g., PNG or JPG) to use as the watermark.
Watermark - X Coordinate Distance in pixels from the top edge of the video where the watermark will be placed.
Watermark - Y Coordinate Distance in pixels from the left edge of the video where the watermark will be placed.
Wait for Completion If true, the node waits until the video processing is complete and returns the full video object; if false, it returns only the ID and creation timestamp immediately.
Webhook URL Optional URL to receive webhook notifications about the video processing status, including video ID and URL.

Output

The node outputs JSON data representing the processed video object returned by the Bookoly API. When "Wait for Completion" is enabled, this includes detailed information about the generated video such as its URL, metadata, and status. If waiting is disabled, the output contains minimal information like the video ID and creation timestamp.

If the node supports binary data output (not explicitly shown here), it would typically represent the actual video file or thumbnail images, but this node primarily works with URLs and metadata.

Dependencies

  • Requires an active connection to the Bookoly API via an API key credential.
  • The node expects publicly accessible URLs for both the input video and the watermark image.
  • Network access to https://bookoly.com/api/v1 is necessary.
  • Optionally, a webhook endpoint can be configured to receive asynchronous notifications.

Troubleshooting

  • Invalid or inaccessible URLs: Ensure that the video and watermark image URLs are publicly accessible and downloadable. Private or protected URLs will cause failures.
  • Incorrect coordinate values: Coordinates must be non-negative integers. Negative or out-of-bound values may result in errors or unexpected watermark placement.
  • API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Timeouts or long processing times: If "Wait for Completion" is enabled, large videos might take time to process. Consider using the webhook URL to handle asynchronous completion.
  • Missing required parameters: The node requires certain fields like video URL, watermark URL, and coordinates. Omitting these will cause validation errors.

Links and References

Discussion