This endpoint allows users to remix an input audio file or URL using a descriptive prompt, optional lyrics, and a gender selection for vocal tone.
⚠️ Deprecation Notice:
REMIX
functionality is supported via this route.INPAINT
, OVER_INSTRUMENTAL
, etc.) are non-functional and removed./inpaint
, /extend
, or /sing_over_instrumental
for other tasks. Also fields such as replace_start_at, replace_end_at, extend_after, audio_path are also deprecated.Parameter | Type | Required | Description |
---|---|---|---|
audio_file | UploadFile | Optional | Upload the audio file directly. Required if audio_url is not provided. |
audio_url | String | Optional | Public URL or S3 path to audio. Required if audio_file is not provided. |
audio_path | String | ❌ Deprecated | Use audio_url instead. |
prompt | String | ✅ Yes | Describes how the audio should be transformed. |
lyrics | String | Optional | Lyrics to guide remix or vocal generation. Max 2000 characters. |
gender | String | Optional | Vocal tone. One of: male , female , neutral . |
webhook_url | String | Optional | Callback URL for async response. |
💡 Note: Eitheraudio_file
oraudio_url
must be provided. Other parameters likemode
,replace_start_at
,extend_after
, etc. have been deprecated and removed.
Webhook responses include detailed metadata including task_id, conversion_id, audio files (conversion_path), lyrics etc.
prompt
, or neither audio_file
nor audio_url
provided.
/Remix
endpoint produces a downloadable or streamable remixed audio file with optional lyrical overlays and style transformations.
Successfully initiated remix task
The response is of type object
.