Endpoint
Request Parameters
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_file
oraudio_url
— at least one is required.
Sample Output
Listen to a real output: Prompt: sing over instrumental in classical slow vibe - audio input : Moana How Far We will Go. Download AudioTry it Yourself
Use the Sing Over Insturmental Endpoint Explorer to test this endpoint live with your own inputs.Sample Request
cURL
Python
🔐 Be sure to replace the placeholders like <api_key>
and file paths with real values.
Sample Response
Success (200 OK)
Webhook Response
When the process completes, the providedwebhook_url
(if any) will receive a JSON POST with:
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 fields like
prompt
orlyrics
, or no audio input provided. - 500 Internal Server Error: Unexpected error during processing.
Use this endpoint to effortlessly bring your lyrics to life with expressive vocals over any instrumental.
Authorizations
Body
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 like Adele in a soulful tone"
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"