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
Callback Request Format
When the task is completed, the system will send different format callback data based on the separation type you selected:Status Code Description
Callback status code indicating task processing result:
Status Code | Description |
---|---|
200 | Success - Vocal separation completed |
400 | Bad Request - Parameter error, unsupported audio file format, etc. |
451 | Download Failed - Unable to download source audio file |
500 | Server Error - Please try again later |
Status message providing detailed status description
Task ID, consistent with the taskId returned when you submitted the task
Vocal separation result information, returned on success
separate_vocal Type Field Description
Original mixed audio file URL
Instrumental-only audio file URL (vocals removed)
Vocals-only audio file URL (instrumental removed)
split_stem Type Field Description
Original mixed audio file URL
Vocals-only audio file URL
Backing vocals audio file URL
Drums audio file URL
Bass audio file URL
Guitar audio file URL
Keyboard audio file URL
Percussion audio file URL
Strings audio file URL
Synthesizer audio file URL
Effects audio file URL
Brass audio file URL
Woodwinds audio file URL
Callback Reception Examples
Here are example codes for receiving callbacks in popular programming languages: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
- File Management: Separated audio file download and processing should be done in asynchronous tasks
- Type Detection: Determine separation type based on returned fields and apply corresponding processing logic
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
- split_stem mode produces more files, pay attention to storage space management
- Ensure source audio file contains corresponding musical components for optimal separation results
- Different separation types have different callback structures, requiring appropriate processing logic
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
- Ensure proper handling of different separation type data structures
Audio Processing Issues
Audio Processing Issues
- Confirm that separated audio file URLs are accessible
- Check audio download permissions and network connections
- Verify audio save paths and permissions
- Note how source audio file quality affects separation results
- Confirm source audio file format is supported
- split_stem mode requires checking more audio files
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.