bookoly icon

bookoly

Interact with the bookoly API

Overview

This node integrates with the Bookoly API to add subtitles to a video from an external subtitle file. It is useful when you have a video hosted online and a corresponding subtitle file (in ASS format) also accessible via URL, and you want to merge these subtitles into the video automatically.

Common scenarios include:

  • Enhancing accessibility by embedding subtitles into videos for hearing-impaired viewers.
  • Preparing videos for multilingual audiences by adding subtitle tracks.
  • Automating video post-production workflows where subtitles are generated or edited separately and then merged.

For example, you might provide a publicly accessible video URL and a subtitle file URL in ASS format, and the node will process and return a new video object with the subtitles embedded.

Properties

Name Meaning
Name The name of the video to be processed.
Video URL The public and downloadable URL of the source video file.
Type The subtitle file format. Currently supports only "Advanced SubStation Alpha (ASS)".
Subtitle URL The public and downloadable URL of the subtitle file to be added to the video.
Wait for Completion If enabled, the node waits until the video processing is complete and returns the full video object; if disabled, it returns only the video 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. When waiting for completion, this includes detailed information about the newly created video with subtitles embedded. If not waiting, the output contains minimal metadata such as the video ID and creation timestamp.

If a webhook URL is provided, notifications about the video processing progress and completion will be sent to that URL asynchronously.

The node does not output binary data directly; instead, it provides URLs or identifiers to access the processed video.

Dependencies

  • Requires access to the Bookoly API service at https://bookoly.com/api/v1.
  • Needs an API key credential configured in n8n for authenticating requests to the Bookoly API.
  • The video and subtitle files must be publicly accessible via direct URLs.
  • Optional webhook URL must be a valid endpoint capable of receiving POST requests.

Troubleshooting

  • Invalid or inaccessible URLs: Ensure both the video URL and subtitle URL are publicly accessible and downloadable. Private or protected URLs will cause failures.
  • Unsupported subtitle format: Currently, only ASS subtitle format is supported. Using other formats may result in errors.
  • API authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Timeouts or long processing times: If "Wait for Completion" is enabled, large videos or complex subtitles may take time. Consider using the webhook URL to handle asynchronous notifications instead.
  • Webhook delivery failures: Confirm that the webhook URL is reachable and accepts incoming POST requests; otherwise, notifications will fail.

Common error messages typically indicate missing parameters, invalid URLs, or API request failures. Reviewing the error details and verifying input properties usually resolves these issues.

Links and References

Discussion