Sonilo Video to Audio Serverless API

Generate video-synced music and sound effects from footage.

POST /v2/sonilo-video-to-audio · submit + poll
 1# pip install "segmind>=1.1.0"
 2# export SEGMIND_API_KEY="YOUR_API_KEY"
 3from segmind import SegmindClient, InferenceFailed, InferenceTimeout
 4
 5# Async (v2) — recommended for long-running / video models.
 6# run() blocks up to 600s; submit_async + job.wait(timeout=...) sets a longer
 7# deadline and keeps the request_id so you can re-poll later.
 8client = SegmindClient()                      # reads SEGMIND_API_KEY
 9payload = {
10    "video_url": "https://segmind-resources.s3.amazonaws.com/input/sonilo-video-to-audio-src.mp4",
11    "sound_type": "music_and_sfx",
12    "music_prompt": "cinematic emotional orchestral score, warm swelling strings, hopeful and majestic, ocean adventure theme",
13    "sfx_prompt": "ocean waves crashing on rocks, sea spray, distant seagulls, coastal wind",
14}
15job = client.submit_async("sonilo-video-to-audio", **payload)
16print(job.request_id)                         # available immediately
17try:
18    result = job.wait(timeout=900, interval=2.0)
19    print(result["status"])                  # COMPLETED
20    print(result.get("output"))              # model output (e.g. video URL)
21except InferenceTimeout as e:
22    print("still running:", e.request_id)    # re-poll later with this id
23except InferenceFailed as e:
24    print("failed:", e.detail)
25
26# Fast models (<=600s) can use the one-liner instead:
27# result = segmind.run("sonilo-video-to-audio", **payload)

API Endpoint

POSThttps://api.segmind.com/v1/sonilo-video-to-audio

Parameters

video_urlrequired
string (uri)

Public HTTP(S) URL of the source video.

duckingoptional
boolean

Lower the music under speech. Music modes only.

Default: true
music_promptoptional
string

Guides the generated music. Used when sound_type is music or music_and_sfx.

music_segmentsoptional
object[]

Timed music prompts (music only). Starts must be >= 5s apart.

Array items:
startrequired
number
promptrequired
string
Max length: 200
output_formatoptional
string

music: m4a or wav. sfx: wav, mp3, aac or flac. Not supported for music_and_sfx.

Allowed values :
"m4a""wav""mp3""aac""flac"
preserve_speechoptional
boolean

Keep speech from the source video. Music modes only.

Default: false
sfx_promptoptional
string

Guides the generated sound effects. Used when sound_type is sfx or music_and_sfx.

sfx_segmentsoptional
object[]

Contiguous timed SFX prompts (sfx or music_and_sfx). First must start at 0.

Array items:
startrequired
number
endrequired
number
promptrequired
string
Max length: 200
sound_typeoptional
string

Which soundtrack to generate.

Default: "music"
Allowed values :
Music"music"
Sound Effects"sfx"
Music + Sound Effects"music_and_sfx"

Response Type

Returns: Video

Asynchronous requests (v2)

Use Async for video, long-running (>~60s), or high-concurrency workloads; Sync is simplest for fast image & LLM calls. Async submits a request and you poll it to completion.

  1. 1
    POST /v2/sonilo-video-to-audio

    Submitreturns request_id, status_url, response_url

  2. 2
    GET /v2/requests/{id}/status

    Polluntil COMPLETED or FAILED

  3. 3
    GET /v2/requests/{id}

    Resultfinal response body

Status states

QUEUEDAccepted, waiting for a worker
PROCESSINGRunning on a worker
COMPLETEDDone — result body is ready
FAILEDErrored (incl. content/RAI blocks)
  • A FAILED request is served as HTTP 422 — the body still carries the error detail.
  • An unknown or expired request_id returns HTTP 404.
  • Results are retained for 1 hour, then expire.
  • Content / RAI blocks surface as FAILED, not a separate state.
  • Track completion by polling the status endpoint.

Common Error Codes

The API returns standard HTTP status codes. Detailed error messages are provided in the response body.

400

Bad Request

Invalid parameters or request format

401

Unauthorized

Missing or invalid API key

403

Forbidden

Insufficient permissions

404

Not Found

Model or endpoint not found

406

Insufficient Credits

Not enough credits to process request

429

Rate Limited

Too many requests

500

Server Error

Internal server error

502

Bad Gateway

Service temporarily unavailable

504

Timeout

Request timed out