Sign in

Overlay video

Layer one video on top of another as picture-in-picture. Async — returns 202 with a pending job; poll GET /tool_jobs/{uid} until status is completed or failed.

post/tools/overlay_video

Request body

base_video_urlstring uri required

Base video URL

overlay_video_urlstring uri required

Overlay video URL

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

scalenumber

1.0 = original size

startnumber

When the overlay begins

metadatastring

Arbitrary metadata string stored with the tool run

Response

Tool run accepted

uidstring
tool'overlay_video'
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

No recorded changes to this endpoint across all 1 revision of this API.