BAbannerbear

Add timed overlays

Changed on

Place several overlay videos on one video at set times. Async — returns 202 with a pending job; poll GET /tool_jobs/{uid} until status is completed or failed.

post/tools/add_timed_overlays

Request

  • Base URL
    https://api.bannerbear.com/v5
  • Auth
    HTTP bearer

Request body

base_video_urlstring uri required

Base video URL

overlay_video_urlsstring[] required

1 to 10 overlays, in the same order as the start times

startsstring[] required

When each overlay begins, one number for each overlay

overlay_size'original' | 'match_base_width'

match_base_width scales each overlay to the width of the base video. Defaults to original

position'top_left' | 'top_center' | 'top_right' | 'center' | 'bottom_left' | 'bottom_center' | 'bottom_right'

Snap to a corner or edge. Use this or x/y, not both

margininteger

Gap from the edge when using position. Defaults to 0

xinteger

Absolute position from the left. Ignored when position is set

yinteger

Absolute position from the top. Ignored when position is set

metadatastring

Arbitrary metadata string stored with the tool run

Response

Tool run accepted

uidstring
tool'add_timed_overlays'
status'pending' | 'running' | 'completed' | 'failed'

pending → running → completed / failed

progressinteger

0-100 job progress, 100 once completed

inputsobject

Inputs the job was created with

metadatastring nullable

Arbitrary metadata string round-tripped from the create request

selfstring uri
created_atstring date-time
completed_atstring date-time nullable
error_messagestring nullable

Human-readable failure reason (only present on failed jobs)

Changes