Add image overlay

Burn a logo, watermark, or badge onto a video. Async — returns 202 with a pending job; poll GET /tool_jobs/{uid} until status is completed or failed.

post/tools/overlay_image

Request body

video_urlstring uri required

Video URL

image_urlstring uri required

Overlay image URL

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

opacitynumber

0.0 to 1.0

metadatastring

Arbitrary metadata string stored with the tool run

Tool run accepted

uidstring

tool'overlay_image'

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)

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