bookoly icon

bookoly

Interact with the bookoly API
Join our community

Actions25

Overview

The "Add Subtitles to a Video" operation in the Video resource allows users to embed styled subtitles directly onto a video file accessible via a public URL. This node is useful for content creators, marketers, educators, or anyone needing to enhance videos with readable subtitles for accessibility, language translation, or emphasis.

Typical use cases include:

  • Adding captions to social media videos to improve engagement.
  • Creating multilingual subtitle tracks for educational videos.
  • Highlighting spoken words dynamically during presentations or tutorials.

By configuring subtitle style, language, font, color, position, and orientation, users can customize how subtitles appear on their videos. The node supports waiting for the video processing to complete or receiving webhook notifications for asynchronous workflows.

Properties

Name Meaning
Name The name of the video to be processed.
Video URL The publicly accessible and downloadable URL of the video file to which subtitles will be added.
Subtitle - Style The visual style of the subtitles. Options: Simple, Signal, Rainbow, Highlight Current Word (default), Signal Highlight Current Word, Rainbow Highlight Current Word.
Subtitle - Language The language code for the subtitles, e.g., English (en), Spanish (es), Chinese (zh), etc. A wide range of languages is supported.
Subtitle - Font Family The font family used for subtitle text. Options include Arial, Charm, Eagle Lake, Libre Baskerville, Lobster, Luckiest Guy (default), Marck Script, Nanum Pen Script, Nunito, Pacifico, Roboto, Korean variants, and Chinese variants.
Subtitle - Font Size The size of the subtitle font, from 1 to 100. Default is 20.
Subtitle - Word Color The HEX color code for the subtitle words, e.g., #FEEE15 for yellow.
Subtitle - Line Color The HEX color code for the subtitle line, e.g., #FFFFFF for white.
Subtitle - Line Words Number of words displayed at once in the subtitle line, between 1 and 10. Default is 4.
Subtitle - Outline Width The width of the outline around subtitle text, from 1 to 100. Default is 5.
Subtitle - Position Where subtitles are placed on the video frame. Options include Top Left, Top Center, Top Right, Center Left, Center Center, Center Right, Bottom Left, Bottom Center, Bottom Right, Mid Top Center, Mid Bottom Center (default).
Subtitle - Orientation Text direction of subtitles: Left to Right (default) or Right to Left.
Wait for Completion If true (default), the node waits until the video processing finishes and returns the full video object. If false, it returns only the video ID and creation timestamp immediately.
Webhook URL Optional URL to receive webhook notifications about 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 finished video with subtitles embedded. If not waiting, the output contains minimal metadata such as 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 assets.

Dependencies

  • Requires an active connection to the Bookoly API service.
  • Needs an API key credential configured in n8n for authentication with the Bookoly platform.
  • Internet access to download the source video from the provided URL and upload the processed video back to the service.
  • Optional webhook endpoint configured by the user to receive asynchronous notifications.

Troubleshooting

  • Common Issues:

    • Invalid or inaccessible video URL: Ensure the video URL is publicly accessible and downloadable.
    • Unsupported video format: Confirm the video format is supported by the Bookoly API.
    • Incorrect language or style options: Use valid values from the provided lists.
    • Network or API authentication errors: Verify API credentials and network connectivity.

  • Error Messages:

    • No handler found for video.addSubtitlesToVideo: Indicates the operation is not implemented or incorrectly referenced.
    • Failed to execute addSubtitlesToVideo: <error message>: General failure during execution; check error details for specifics.
    • Timeout or webhook delivery failures: Check webhook URL validity and server availability.

  • Resolutions:

    • Double-check all input parameters for correctness.
    • Validate API credentials and permissions.
    • Test webhook URLs independently to ensure they accept POST requests.
    • Retry with smaller or simpler videos if processing fails.

Links and References

Discussion