Skip to main content
When you submit a task to the Music Video Generation 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:
  • Music video generation task completed successfully
  • Music video generation task failed
  • Errors occurred during task processing

​
Callback Method

  • HTTP Method: POST
  • Content Type: application/json
  • Timeout Setting: 15 seconds

​
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": "MP4 generated successfully.",
  "data": {
    "task_id": "taskId_774b9aa0422f",
    "video_url": "https://example.com/videos/video_847715e66259.mp4"
  }
}

​
Status Code Description

​
code
integer
required
Callback status code indicating task processing result:
Status CodeDescription
200Success - Music video generation 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.video_url
string
Generated MP4 video file download URL, returned on success

​
Callback Reception Examples

Here are example codes for receiving callbacks in popular programming languages:
  • Node.js
  • Python
  • PHP
const express = require('express');
const app = express();

app.use(express.json());

app.post('/music-video-callback', (req, res) => {
  const { code, msg, data } = req.body;
  
  console.log('Received music video generation callback:', {
    taskId: data.task_id,
    status: code,
    message: msg
  });
  
  if (code === 200) {
    // Task completed successfully
    console.log('Music video generation completed');
    console.log(`Video URL: ${data.video_url}`);
    
    // Download video file
    if (data.video_url) {
      const https = require('https');
      const fs = require('fs');
      
      const filename = `music_video_${data.task_id}.mp4`;
      const file = fs.createWriteStream(filename);
      
      https.get(data.video_url, (response) => {
        response.pipe(file);
        file.on('finish', () => {
          file.close();
          console.log(`Video file saved as ${filename}`);
        });
      }).on('error', (err) => {
        console.error('Video file download failed:', err.message);
      });
    }
    
  } else {
    // Task failed
    console.log('Music video generation failed:', msg);
    
    // Handle failure cases...
    if (code === 400) {
      console.log('Parameter error or unsupported audio file 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. Video Processing: Video file download and processing should be done in asynchronous tasks to avoid blocking callback response

​
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 video file URLs may have time limits, recommend downloading and saving promptly
  • MP4 video files are large, pay attention to storage space and download time
  • Ensure sufficient disk space to save video files
  • Video generation may take longer, please be patient for callback notifications

​
Troubleshooting

If you do not receive callback notifications, please check the following:
  • Confirm that the callback URL is accessible from the public network
  • Check firewall settings to ensure inbound requests are not blocked
  • Verify that domain name resolution is correct
  • Ensure the server returns HTTP 200 status code within 15 seconds
  • Check server logs for error messages
  • Verify that the interface path and HTTP method are correct
  • Confirm that the received POST request body is in JSON format
  • Check that Content-Type is application/json
  • Verify that JSON parsing is correct
  • Confirm that video file URLs are accessible
  • Check video download permissions and network connections
  • Verify video save paths and permissions
  • Note video file size, ensure sufficient storage space
  • Confirm source audio file format is supported
  • Check network bandwidth is sufficient for downloading large files

​
Alternative Solution

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

Poll Query Results

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