When you submit a task to the Vocal Separation API, you can use the callBackUrl parameter to set a callback URL. When the task is completed, the system will automatically push the results to your specified address.

​
Callback Mechanism Overview

The callback mechanism eliminates the need to poll the API for task status. The system will proactively push task completion results to your server.

​
Callback Timing

The system will send callback notifications in the following situations:
  • Vocal separation task completed successfully
  • Vocal separation task failed
  • Errors occurred during task processing

​
Callback Method

  • HTTP Method: POST
  • Content Type: application/json
  • Timeout Setting: 15 seconds
  • Retry Mechanism: Retry 3 times after failure, with intervals of 1 minute, 5 minutes, and 15 minutes respectively

​
Callback Request Format

When the task is completed, the system will send a POST request to your callBackUrl in the following format: 
{
  "code": 200,
  "msg": "vocal Removal generated successfully.",
  "data": {
    "task_id": "5e72d367bdfbe44785e28d72cb1697c7",
    "vocal_removal_info": {
      "instrumental_url": "https://tempfile.aiquickdraw.com/v/94322944-2c96-4be3-b7fb-606e3924a8d2_instrumental.mp3",
      "origin_url": "https://cdn1.suno.ai/549fc4b2-294f-44ea-a35b-419687b07ab9.mp3",
      "vocal_url": "https://tempfile.aiquickdraw.com/v/94322944-2c96-4be3-b7fb-606e3924a8d2_vocal.mp3"
    }
  }
}

​
Status Code Description

​
code
integer
required
Callback status code indicating task processing result:
Status CodeDescription
200Success - Vocal separation completed
400Bad Request - Parameter error, unsupported audio file format, etc.
451Download Failed - Unable to download source audio file
500Server Error - Please try again later
​
msg
string
required
Status message providing detailed status description
​
data.task_id
string
required
Task ID, consistent with the taskId returned when you submitted the task
​
data.vocal_removal_info
object
Vocal separation result information, returned on success
​
data.vocal_removal_info.origin_url
string
Original mixed audio file URL
​
data.vocal_removal_info.instrumental_url
string
Instrumental-only audio file URL (vocals removed)
​
data.vocal_removal_info.vocal_url
string
Vocals-only audio file URL (instrumental removed)

​
Callback Reception Examples

Here are example codes for receiving callbacks in popular programming languages: 
const express = require('express');
const app = express();

app.use(express.json());

app.post('/vocal-separation-callback', (req, res) => {
  const { code, msg, data } = req.body;
  
  console.log('Received vocal separation callback:', {
    taskId: data.task_id,
    status: code,
    message: msg
  });
  
  if (code === 200) {
    // Task completed successfully
    console.log('Vocal separation completed');
    const vocalInfo = data.vocal_removal_info;
    
    if (vocalInfo) {
      console.log('Separation results:');
      console.log(`  Original audio: ${vocalInfo.origin_url}`);
      console.log(`  Instrumental only: ${vocalInfo.instrumental_url}`);
      console.log(`  Vocals only: ${vocalInfo.vocal_url}`);
      
      // Download separated audio files
      const https = require('https');
      const fs = require('fs');
      
      const downloadFile = (url, filename) => {
        if (!url) return;
        
        const file = fs.createWriteStream(filename);
        https.get(url, (response) => {
          response.pipe(file);
          file.on('finish', () => {
            file.close();
            console.log(`Saved: ${filename}`);
          });
        }).on('error', (err) => {
          console.error(`Download failed ${filename}:`, err.message);
        });
      };
      
      downloadFile(vocalInfo.instrumental_url, `${data.task_id}_instrumental.mp3`);
      downloadFile(vocalInfo.vocal_url, `${data.task_id}_vocal.mp3`);
    }
    
  } else {
    // Task failed
    console.log('Vocal separation failed:', msg);
    
    // Handle failure cases...
    if (code === 400) {
      console.log('Parameter error or unsupported audio format');
    } else if (code === 451) {
      console.log('Source audio file download failed');
    } else if (code === 500) {
      console.log('Server internal error');
    }
  }
  
  // Return 200 status code to confirm callback received
  res.status(200).json({ status: 'received' });
});

app.listen(3000, () => {
  console.log('Callback server running on port 3000');
});

​
Best Practices

​
Callback URL Configuration Recommendations

  1. Use HTTPS: Ensure your callback URL uses HTTPS protocol for secure data transmission
  2. Verify Source: Verify the legitimacy of the request source in callback processing
  3. Idempotent Processing: The same taskId may receive multiple callbacks, ensure processing logic is idempotent
  4. Quick Response: Callback processing should return a 200 status code as quickly as possible to avoid timeout
  5. Asynchronous Processing: Complex business logic should be processed asynchronously to avoid blocking callback response
  6. File Management: Separated audio file download and processing should be done in asynchronous tasks

​
Important Reminders

  • Callback URL must be a publicly accessible address
  • Server must respond within 15 seconds, otherwise it will be considered a timeout
  • If 3 consecutive retries fail, the system will stop sending callbacks
  • Please ensure the stability of callback processing logic to avoid callback failures due to exceptions
  • Generated audio file URLs may have time limits, recommend downloading and saving promptly
  • Vocal separation produces multiple files, pay attention to storage space management
  • Ensure source audio file contains both vocal and instrumental components for optimal separation results

​
Troubleshooting

If you do not receive callback notifications, please check the following:

​
Alternative Solution

If you cannot use the callback mechanism, you can also use polling:

Poll Query Results

Use the get vocal separation details endpoint to regularly query task status. We recommend querying every 30 seconds.