bookoly icon

bookoly

Interact with the bookoly API

Video → Overlay Videos

AI-generated

Summary

Overlays a second video onto a base video at a chosen position, with optional scaling and offset, and returns the resulting video.

Inputs

  • Video - Name (required) — The name of the video.
  • Video - URL (required) — The public and downloadable URL of the base video.
  • Video - Mute — Whether to mute the base video's original audio.
  • Overlay Video - URL (required) — The public and downloadable URL of the overlay video.
  • Overlay Video - Mute (required) — Whether to mute the overlay video's audio.
  • Position (required) — Where to place the overlay on the base video: top_left, top_right, bottom_left, bottom_right, center, center_top, center_bottom, center_left, or center_right.
  • Scale — Scale percentage of the overlay video (1-100). Leave empty for the API default.
  • X Offset — Horizontal offset in pixels from the position anchor. Leave empty for the API default.
  • Y Offset — Vertical offset in pixels from the position anchor. Leave empty for the API default.
  • Wait for Completion — If enabled, waits for the overlay job to finish and returns the full video object. If disabled, returns only the ID and creation timestamp.
  • Webhook URL — Optional URL to receive webhook notifications. The video ID and URL will be included.

Output shape

Video object

When Wait for Completion is enabled (default), returns the full resulting video object from Bookoly after the overlay job finishes. When disabled, returns only the video ID and creation timestamp.

Links

Discussion