Endpoint
Request Parameters
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.
Sample Output
Listen to a real output: Prompt: remix in classical slow vibe - audio input : Moana How Far We will Go. Download AudioTry it Yourself
Use the Remix Endpoint Explorer to test this endpoint live.Sample Request
cURL
Python
Sample Response
Success (200 OK)
Webhook Response
Webhook Delivery
Once the generation is complete, webhooks will be triggered to deliver the following:Standard Requests (non-instrumental):
- 2 (webhooks) x Remix conversion details (one per version)
- 2 (webhooks) x Lyrics with timestamp data
Webhook responses include detailed metadata including task_id, conversion_id, audio files (conversion_path), lyrics etc.
Common Errors
-
422 Unprocessable Entity
Missing required field
prompt
, or neitheraudio_file
noraudio_url
provided. - 500 Internal Server Error An error occurred during processing or task queueing.
The
/Remix
endpoint produces a downloadable or streamable remixed audio file with optional lyrical overlays and style transformations.
Payload and Request Formation
Authorizations
Body
URL or S3 path to the input audio.
"https://mybucket.s3.amazonaws.com/song.mp3"
Describes how the audio should be transformed.
"Make it sound like Lo-fi with chill beats"
Uploaded audio file to be remixed.
🔴 Deprecated: Use audio_url
instead.
"https://www.youtube.com/watch?v=example123"
Optional lyrics to guide vocal generation.
2000
"It's a brand new day"
Voice style if vocal content is generated.
male
, female
, neutral
"female"
Callback URL for async processing results.
"https://example.com/my-webhook"