From c82f222fbeb6236e2c13ee730649a39122651d3e Mon Sep 17 00:00:00 2001 From: Spencer Qian Date: Wed, 15 Jul 2026 22:22:11 -0700 Subject: [PATCH] docs: video-to-sfx returns audio only (no muxed video) The dedicated video-to-audio endpoint no longer returns a muxed video, so video-to-sfx yields audio only. Fix the README example (which='video' would now raise) and note that SfxResult.video is retained for compatibility but is no longer populated. --- README.md | 3 +-- src/sonilo/types.py | 2 ++ 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2c0130f..dca9bf1 100644 --- a/README.md +++ b/README.md @@ -90,8 +90,7 @@ task = client.video_to_sfx.submit( audio_format="wav", ) result = client.tasks.wait(task.task_id, poll_interval=2.0, timeout=600.0) -result.save("audio.wav") -result.save("with_audio.mp4", which="video") # video-to-sfx also returns the muxed video +result.save("audio.wav") # video-to-sfx returns the generated audio only ``` `tasks.get(task_id)` fetches state once and never raises on a failed task; diff --git a/src/sonilo/types.py b/src/sonilo/types.py index 947671c..816d11f 100644 --- a/src/sonilo/types.py +++ b/src/sonilo/types.py @@ -60,6 +60,8 @@ class SfxResult: status: str type: Optional[str] = None audio: Optional[SfxMedia] = None + # video-to-sfx now returns audio only; `video` is kept for backward + # compatibility but is no longer populated by the API. video: Optional[SfxMedia] = None cost: Optional[float] = None error: Optional[Dict[str, Any]] = None