callBackUrl parameter to set a callback URL. The system will automatically push the results to your specified address when the task is completed.
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
Callback Request Format
When the task is completed, the system will send a POST request to yourcallBackUrl in the following format:
Status Code Description
Callback status code indicating task processing result:
| Status Code | Description |
|---|---|
| 200 | Success - Request has been processed successfully |
| 400 | Validation Error - Lyrics contained copyrighted material |
| 408 | Rate Limited - Timeout |
| 413 | Conflict - Uploaded audio matches existing work of art |
| 500 | Server Error - An unexpected error occurred while processing the request |
| 501 | Audio generation failed |
| 531 | Server Error - Sorry, the generation failed due to an issue. Your credits have been refunded. Please try again |
Status message providing detailed status description
Callback type:
- text - Text generation complete
- first - First track complete
- complete - All tracks complete
- error - Generation failed
Task ID, consistent with the task_id returned when you submitted the task
Generated audio data array, returned on success
Audio unique identifier (audioId)
Audio file URL
Streaming audio URL
Cover image URL
Generation prompt/lyrics
Model name used
Music title
Music tags
Creation time
Audio duration (seconds)
Callback Reception Examples
Here are example codes for receiving callbacks in popular programming languages:- Node.js
- Python
- PHP
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 task_id 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
- Stage Tracking: Differentiate between different generation stages based on callbackType and arrange business logic appropriately
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
- Pay attention to handling different callbackType callbacks, especially the complete type for final results
Troubleshooting
If you do not receive callback notifications, please check the following:Network Connection Issues
Network Connection Issues
- 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
Server Response Issues
Server Response Issues
- 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
Content Format Issues
Content Format Issues
- Confirm that the received POST request body is in JSON format
- Check that Content-Type is application/json
- Verify that JSON parsing is correct
Callback Type Processing
Callback Type Processing
- Confirm proper handling of different callbackTypes
- Check if processing of complete type final results is missed
- Verify that audio data parsing is correct
Alternative Solution
If you cannot use the callback mechanism, you can also use polling:Poll Query Results
Use the get music details endpoint to regularly query task status. We recommend querying every 30 seconds.
