bookoly icon

bookoly

Interact with the bookoly API

Overview

The "Blur a Video" operation in this node allows users to apply a blur effect to a specific rectangular area of a video. This is useful for obscuring sensitive information, faces, or any part of the video that should not be visible. The node takes a publicly accessible video URL and parameters defining the blur area and intensity, then processes the video accordingly.

Common scenarios include:

  • Blurring out license plates or faces in surveillance footage.
  • Obscuring confidential data displayed in a video tutorial.
  • Creating artistic effects by selectively blurring parts of a video.

For example, you can specify the coordinates and size of the blur box to cover a face in a video frame, set the blur power to control how strong the blur appears, and optionally mute the video's audio during processing.

Properties

Name Meaning
Name The name to assign to the processed video.
Video URL The public and downloadable URL of the source video file to be blurred.
Mute Video Whether to mute the original audio track of the video during processing (true/false).
X Coordinate Horizontal position (in pixels) of the top-left corner of the blur rectangle within the video frame.
Y Coordinate Vertical position (in pixels) of the top-left corner of the blur rectangle within the video frame.
Box Width Width (in pixels) of the blur rectangle. Must not exceed the video's width.
Box Height Height (in pixels) of the blur rectangle. Must not exceed the video's height.
Power Intensity of the blur effect; higher values produce stronger blur. Recommended range: 10 to 25.
Wait for Completion If true, the node waits until the video processing finishes 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. When waiting for completion, the output includes the full video object with details such as the final video URL, metadata, and processing status. If not waiting, 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 processed video file itself or related media content.

Dependencies

  • Requires an active API key credential for the external video processing service.
  • The node communicates with the Bookoly API at https://bookoly.com/api/v1.
  • The video URL must be publicly accessible and downloadable by the API.
  • For webhook functionality, a valid publicly reachable URL must be provided to receive asynchronous notifications.

Troubleshooting

  • Invalid Video URL: Ensure the video URL is publicly accessible and points directly to a downloadable video file.
  • Blur Box Out of Bounds: The specified X, Y coordinates and box dimensions must fit within the video's resolution; otherwise, the API may reject the request.
  • API Authentication Errors: Verify that the API key credential is correctly configured and has necessary permissions.
  • Timeouts or Long Processing Times: If "Wait for Completion" is enabled, large videos or high blur power settings may increase processing time. Consider disabling wait or using webhooks.
  • Webhook Failures: Confirm the webhook URL is correct and publicly accessible to receive callbacks.

Common error messages will relate to invalid parameters, authentication failures, or network issues communicating with the API. Reviewing these parameters and credentials usually resolves most problems.

Links and References

Discussion