Music Generation Callbacks

When you submit a task to the Music 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 generation task completed successfully
Music generation 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": "All generated successfully.",
  "data": {
    "callbackType": "complete",
    "task_id": "2fac****9f72",
    "data": [
      {
        "id": "8551****662c",
        "audio_url": "https://example.cn/****.mp3",
        "source_audio_url": "https://example.cn/****.mp3",
        "stream_audio_url": "https://example.cn/****",
        "source_stream_audio_url": "https://example.cn/****",
        "image_url": "https://example.cn/****.jpeg",
        "source_image_url": "https://example.cn/****.jpeg",
        "prompt": "[Verse] Night city lights shining bright",
        "model_name": "chirp-v3-5",
        "title": "Iron Man",
        "tags": "electrifying, rock",
        "createTime": "2025-01-01 00:00:00",
        "duration": 198.44
      },
      {
        "id": "bd15****1873",
        "audio_url": "https://example.cn/****.mp3",
        "source_audio_url": "https://example.cn/****.mp3",
        "stream_audio_url": "https://example.cn/****",
        "source_stream_audio_url": "https://example.cn/****",
        "image_url": "https://example.cn/****.jpeg",
        "source_image_url": "https://example.cn/****.jpeg",
        "prompt": "[Verse] Night city lights shining bright",
        "model_name": "chirp-v3-5",
        "title": "Iron Man",
        "tags": "electrifying, rock",
        "createTime": "2025-01-01 00:00:00",
        "duration": 228.28
      }
    ]
  }
}

Status Code Description

code

integer

required

Callback status code indicating task processing result:

Status Code	Description
200	Success - Music generation completed
400	Bad Request - Parameter error, content violation, etc.
451	Download Failed - Unable to download related files
500	Server Error - Please try again later

msg

string

required

Status message providing detailed status description

data.callbackType

string

required

Callback type indicating the current callback stage:

text: Text generation completed
first: First music track completed
complete: All music tracks completed
error: Task failed

data.task_id

string

required

Task ID, consistent with the taskId returned when you submitted the task

data.data

array

Music generation result information, returned on success

data.data[].id

string

Music unique identifier

data.data[].audio_url

string

Generated audio file URL

data.data[].source_audio_url

string

Original audio file URL

data.data[].stream_audio_url

string

Streaming audio URL

data.data[].source_stream_audio_url

string

Original streaming audio URL

data.data[].image_url

string

Cover image URL

data.data[].source_image_url

string

Original cover image URL

data.data[].prompt

string

Generation prompt/lyrics

data.data[].model_name

string

Model name used

data.data[].title

string

Music title

data.data[].tags

string

Music tags

data.data[].createTime

string

Creation time

data.data[].duration

number

Audio duration (seconds)

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('/generate-music-callback', (req, res) => {
  const { code, msg, data } = req.body;
  
  console.log('Received music generation callback:', {
    taskId: data.task_id,
    callbackType: data.callbackType,
    status: code,
    message: msg
  });
  
  if (code === 200) {
    // Task completed successfully
    console.log('Music generation completed');
    const musicData = data.data || [];
    
    console.log(`Generated ${musicData.length} music tracks:`);
    musicData.forEach((music, index) => {
      console.log(`Music ${index + 1}:`);
      console.log(`  Title: ${music.title}`);
      console.log(`  Duration: ${music.duration} seconds`);
      console.log(`  Tags: ${music.tags}`);
      console.log(`  Audio URL: ${music.audio_url}`);
      console.log(`  Cover URL: ${music.image_url}`);
    });
    
    // Process generated music
    // Can download audio files, save locally, etc.
    
  } else {
    // Task failed
    console.log('Music generation failed:', msg);
    
    // Handle failure cases...
    if (code === 400) {
      console.log('Parameter error or content violation');
    } else if (code === 451) {
      console.log('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

Use HTTPS: Ensure your callback URL uses HTTPS protocol for secure data transmission
Verify Source: Verify the legitimacy of the request source in callback processing
Idempotent Processing: The same taskId may receive multiple callbacks, ensure processing logic is idempotent
Quick Response: Callback processing should return a 200 status code as quickly as possible to avoid timeout
Asynchronous Processing: Complex business logic should be processed asynchronously to avoid blocking callback response
Audio Processing: Audio 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 audio URLs may have time limits, recommend downloading and saving promptly
Pay attention to content policy compliance to avoid generation failures due to policy violations

Troubleshooting

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

Network Connection Issues

Server Response Issues

Content Format Issues

Audio Processing Issues

Alternative Solution

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

Poll Query Results

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

Generate Music

Generate Lyrics

WAV Conversion

Vocal Removal

Music Video Generation

Account Management

File Upload API

Music Generation Callbacks

Callback Mechanism Overview

Callback Timing

Callback Method

Callback Request Format

Status Code Description

Callback Reception Examples

Best Practices

Callback URL Configuration Recommendations

Important Reminders

Troubleshooting

Alternative Solution

Poll Query Results

Generate Music

Generate Lyrics

WAV Conversion

Vocal Removal

Music Video Generation

Account Management

File Upload API

​Callback Mechanism Overview

​Callback Timing

​Callback Method

​Callback Request Format

​Status Code Description

​Callback Reception Examples

​Best Practices

​Callback URL Configuration Recommendations

​Important Reminders

​Troubleshooting

​Alternative Solution

Poll Query Results

Callback Mechanism Overview

Callback Timing

Callback Method

Callback Request Format

Status Code Description

Callback Reception Examples

Best Practices

Callback URL Configuration Recommendations

Important Reminders

Troubleshooting

Alternative Solution