bookoly icon

bookoly

Interact with the bookoly API

Overview

The node integrates with the Bookoly API to perform various video processing operations. Specifically, for the Crop a Video operation under the Video resource, it allows users to crop a video by specifying the rectangular area to keep. This is useful when you want to focus on a particular part of a video frame or remove unwanted edges.

Common scenarios include:

  • Removing black bars or watermarks from video edges.
  • Zooming in on a specific subject or region within the video.
  • Preparing videos for social media formats that require specific aspect ratios.

For example, cropping a 1920x1080 video to a 1280x720 area starting at coordinates (100, 50) will produce a new video focusing on that portion.

Properties

Name Meaning
Name The name to assign to the resulting cropped video.
Video URL The publicly accessible and downloadable URL of the source video file to be cropped.
Mute Video Whether to mute the original audio track of the video during processing (true/false).
Crop - X Coordinate The horizontal pixel coordinate of the top-left corner of the crop rectangle (minimum 0).
Crop - Y Coordinate The vertical pixel coordinate of the top-left corner of the crop rectangle (minimum 0).
Crop - Width The width in pixels of the cropped area; must not exceed the original video width.
Crop - Height The height in pixels of the cropped area; must not exceed the original video height.
Wait for Completion If true, the node waits until the video processing finishes and returns the full video object; if false, only the ID and creation timestamp are returned 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, this includes the full video object with metadata such as video URL, status, and other details. 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.

Dependencies

  • Requires an active connection to the Bookoly API service.
  • Needs an API key credential configured in n8n for authentication with the Bookoly API.
  • Internet access to download the source video from the provided URL and upload the processed video back to Bookoly servers.
  • Optional: A valid webhook URL endpoint if webhook notifications are used.

Troubleshooting

  • Invalid Crop Dimensions: Errors may occur if the crop width or height exceeds the original video dimensions. Ensure these values are within bounds.
  • Invalid Video URL: The video URL must be publicly accessible and downloadable. Private or restricted URLs will cause failures.
  • API Authentication Errors: Missing or invalid API credentials will prevent the node from communicating with the Bookoly API.
  • Timeouts or Long Processing Times: If "Wait for Completion" is enabled, large videos may take time to process. Consider disabling wait and using webhooks for asynchronous handling.
  • Webhook Failures: If webhook URL is invalid or unreachable, notifications will fail. Verify the webhook endpoint is correct and publicly accessible.

Links and References

Discussion