Video to SFX

Create async job

Start an async video-to-sfx generation job. Returns immediately with a job_id. Recommended for videos longer than 10 seconds.

post/v2/video-to-sfx/v1.6/jobs

Request

  • Base URL: https://api.mirelo.ai
  • URL: https://api.mirelo.ai/v2/video-to-sfx/v1.6/jobs
  • Auth: HTTP bearer

Request body

duration_msnumber required

Duration in milliseconds

start_offset_msnumber

Start offset into the video in milliseconds. Defaults to 0 (beginning of video).

promptstring

Optional text prompt. When provided, the video drives the timing while the prompt guides which sound to generate (video-synced style transfer). Omit for pure video-driven generation.

num_samplesinteger

Number of audio variants to generate

output'audio' | 'video'

Output format. "audio" (default) returns SFX audio files only. "video" returns the original video with the generated SFX mixed in.

seedinteger nullable

Seed for reproducible generation. Integer, minimum -1. Omit, or send -1 or null, for a randomly chosen seed. It does not guarantee identical audio because generation is not bit-deterministic across inference workers.

output_format'wav' | 'mp3' | 'aac' | 'flac'

Container for the generated audio. One of "wav" (default), "mp3", "aac", "flac". Omit for WAV, which is what every request returned before this parameter existed. Requests that need server-side post-processing — a tiled loop, a windowed extend or inpaint, a long video clip — are generated losslessly and encoded into this container once, at the end.

Example request

{
  "video": {
    "type": "url",
    "video_url": "https://example.com/clip.mp4"
  },
  "duration_ms": 10000,
  "num_samples": 1,
  "output": "audio"
}

Response

Job accepted

job_idstring uuid required

Unique identifier for the async job

job_urlstring required

Relative URL to poll for job status, e.g. /v2/text-to-sfx/{version}/jobs/{job_id}. Append to your API base URL to form the full polling URL.

estimated_msinteger required

Estimated completion time in milliseconds

estimated_completion_atstring date-time required

ISO 8601 estimated completion timestamp

Changes

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