Usage Guide
- Use this endpoint to check the status of a vocal separation task
- Access the URLs for vocal, instrumental, and individual instrument tracks once processing is complete
- Track processing progress and any errors that may have occurred
Status Descriptions
PENDING
: Task is waiting to be processedSUCCESS
: Vocal separation completed successfullyCREATE_TASK_FAILED
: Failed to create the separation taskGENERATE_AUDIO_FAILED
: Failed during audio processingCALLBACK_EXCEPTION
: Error occurred during callback
Developer Notes
- URLs for all audio files (original, vocal, instrumental, drums, bass, guitar, piano) are only available when status is
SUCCESS
- Error codes and messages are provided for failed tasks
- Separated audio files are retained for 14 days after successful processing
Authorizations
All APIs require authentication via Bearer Token.
Get API Key:
- Visit API Key Management Page to get your API Key
Usage: Add to request header: Authorization: Bearer YOUR_API_KEY
Note:
- Keep your API Key secure and do not share it with others
- If you suspect your API Key has been compromised, reset it immediately in the management page
Query Parameters
Unique identifier of the vocal separation task to retrieve. This is the taskId returned when creating the vocal separation task.
Response
Request successful
Response status code
- 200: Success - Request has been processed successfully
- 401: Unauthorized - Authentication credentials are missing or invalid
- 404: Not Found - The requested resource or endpoint does not exist
- 422: Validation Error - The request parameters failed validation checks
- 451: Failed to fetch the image. Kindly verify any access limits set by you or your service provider.
- 455: Service Unavailable - System is currently undergoing maintenance
- 500: Server Error - An unexpected error occurred while processing the request
Available options:
200
, 401
, 404
, 422
, 451
, 455
, 500
Error message when code != 200
Example:
"success"