Remix
Processes an input audio file or audio path along with a textual prompt to generate a remix. The remix type is specified using the mode
parameter. The task is queued and responds with task ID, ETA, credit estimate, and status message.
Create a remix using an input audio file and a prompt.
Endpoint
This endpoint processes an input audio file along with a textual prompt to generate a remix. You can specify a webhook_url
to receive a callback when processing completes.
Request Parameters
Parameter | Type | Required | Description |
---|---|---|---|
audio_file | UploadFile | Optional | Upload the audio file directly. Required if audio_path is not provided. |
audio_path | String | Optional | A URL to an audio file (S3 or YouTube). Required if audio_file is not provided. |
prompt | String | Required | The text prompt guiding the remix generation. Example: โGenerate a soothing ambient soundscape.โ |
lyrics | String | Optional | If provided, lyrics will be used to generate the remix. |
mode | String | Required | Remix mode. Must be one of REMIX , INPAINT , OVER_INSTRUMENTAL . |
webhook_url | String | Optional | Callback URL for async response. Defaults to empty string if not provided. |
๐ก Note: You must provide either
audio_file
oraudio_path
โ at least one is required.
Sample Output
Listen to a real sample output:
Prompt: a song about greenery, nature and forest.
Download AudioTry it Yourself
Visit the MusicAI Endpoint Explorer to play around โ set your payload, hit send, and listen to the generated results live.
Sample Request
cURL
Python
๐ Replace
{path_to_your_audio_file}
,api_key
, andwebhook_url
before executing.
Sample Response
Success (200 OK)
Webhook Response
When the remix process completes, the webhook receives:
Webhook Delivery
Once the generation is complete, webhooks will be triggered to deliver the following:
Standard Requests (non-instrumental):
- 2 (webhooks) x Remix details (one per version)
- 2 (webhooks) x Lyrics with timestamp data
- 1 (webhook ) x Album cover image
Webhook responses include detailed metadata including task_id, conversion_id, audio files (conversion_path), lyrics etc.
Common Errors
- 422 Unprocessable Entity: Missing required fields like
prompt
, or neitheraudio_file
noraudio_path
provided. - 500 Internal Server Error: An unexpected error occurred during processing.
The response provides a downloadable or streamable remix audio file.
Authorizations
Body
Response
Successfully initiated remix task
The response is of type object
.