bookoly icon

bookoly

Interact with the bookoly API

Overview

The node integrates with the Bookoly API to perform video processing tasks. Specifically, the "Frame a Video" operation extracts a single frame image from a video at a specified timestamp (in seconds). This is useful for generating thumbnails, preview images, or snapshots from videos hosted at publicly accessible URLs.

Common scenarios include:

  • Automatically generating thumbnail images for video content.
  • Capturing key moments in a video for use in marketing or documentation.
  • Extracting frames for quality checks or visual analysis.

Example: Given a URL to a promotional video, you can extract a frame at 5.2 seconds to use as a thumbnail on your website.

Properties

Name Meaning
Name The name identifier for the video being processed.
Video URL The public and downloadable URL of the video file to process.
Timestamp (Seconds) The exact time point in the video (in seconds) from which to capture the frame. Supports decimal values (e.g., 5.2).
Wait for Completion If enabled, the node waits until the frame extraction is complete and returns the full video object; otherwise, it returns only an 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 result of the frame extraction operation. When waiting for completion, this includes detailed information about the generated frame or video object. If not waiting, the output contains minimal metadata such as the ID and creation timestamp.

If the node supports binary data output (not explicitly shown here), it would typically provide the extracted frame image as binary data for further workflow use.

Dependencies

  • Requires access to the Bookoly API service at https://bookoly.com/api/v1.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The video must be accessible via a public and downloadable URL.
  • Optional webhook URL requires a reachable endpoint to receive asynchronous notifications.

Troubleshooting

  • Invalid or inaccessible video URL: Ensure the provided video URL is publicly accessible and downloadable. Private or restricted URLs will cause failures.
  • Timestamp out of range: Specifying a timestamp beyond the video duration may result in errors or empty frames.
  • API authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Webhook delivery issues: If using webhook notifications, ensure the webhook URL is valid and can accept POST requests.
  • Timeouts when waiting for completion: Large videos or slow processing might cause delays; consider disabling wait or increasing timeout settings if available.

Common error messages:

  • "No handler found for video.frameVideo": Indicates misconfiguration or missing implementation for the requested operation.
  • "Failed to execute frameVideo: <error message>": General failure during execution; check the error message for details.

Links and References

Discussion