This endpoint allows users to sing over an instrumental audio track using a text prompt and lyrics. It supports either a file upload or a URL to the input audio and generates a vocal overlay based on the provided lyrics and style.
ℹ️Experimental Feature: We do not guarantee continuous reliability and a bug-free experience as this feature is in beta.
| Parameter | Type | Required | Description |
|---|---|---|---|
audio_file | UploadFile | Optional | Upload the instrumental audio file. Required if audio_url is not provided. |
audio_url | String | Optional | URL or youtube link to the instrumental audio. Required if audio_file is not provided. |
prompt | String | Required | Text describing the desired singing style. Example: “Sing in soft jazz style” |
lyrics | String | Required | The lyrics to be sung over the instrumental. Max 2000 characters. |
gender | String | Optional | Voice style. Options: male, female, neutral. |
webhook_url | String | Optional | Callback URL to receive processing results. |
💡 Note: You must provide eitheraudio_fileoraudio_url— at least one is required.
content-type: multipart/form-data
🔐 Be sure to replace the placeholders like <api_key> and file paths with real values.
webhook_url (if any) will receive a JSON POST with:
Webhook responses include detailed metadata including task_id, conversion_id, audio files (conversion_path), lyrics etc.
prompt or lyrics, or no audio input provided.URL or S3 path to the input instrumental audio.
"https://bucket.s3.amazonaws.com/audio.mp3"
Description of the singing style, tone, or genre.
"Sing emotional vocals over a soft piano instrumental."
The lyrics to be sung over the instrumental.
2000"Never mind I'll find someone like you..."
Uploaded instrumental audio file.
Voice gender to guide generation.
male, female, neutral "female"
Callback URL to receive status updates or final audio result.
"https://yourdomain.com/webhook"