Add or replace audio

Mix an audio track over a video, or replace the original. Async — returns 202 with a pending job; poll GET /tool_jobs/{uid} until status is completed or failed.

post/tools/add_audio

Request body

video_urlstring uri required

Video URL

audio_urlstring uri required

Audio URL

mode'mix' | 'replace' required

Mode

volumenumber

1.0 = original level

loop'on' | 'off'

Loop the audio to match the video's length. Turn off for one-shot sounds

ducking'off' | 'subtle' | 'medium' | 'heavy'

Dip the new audio when the video's original audio is present. Mix mode only

metadatastring

Arbitrary metadata string stored with the tool run

Response

Tool run accepted

uidstring

tool'add_audio'

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.