Usage Guide
- Use this endpoint to check task status and access generation results
- Task details include status, parameters, and generated tracks
- Generated tracks can be accessed through the returned URLs
Status Descriptions
PENDING: Task is waiting to be processedTEXT_SUCCESS: Lyrics/text generation completed successfullyFIRST_SUCCESS: First track generation completedSUCCESS: All tracks generated successfullyCREATE_TASK_FAILED: Failed to create taskGENERATE_AUDIO_FAILED: Failed to generate audioCALLBACK_EXCEPTION: Error during callback processSENSITIVE_WORD_ERROR: Content filtered due to sensitive words
Developer Notes
- For instrumental tracks (
instrumental=true), no lyrics data will be included - Maximum query rate: 3 requests per second per task
- Response includes direct URLs to audio files, images, and streaming endpoints
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 music generation task to retrieve. This can be either a taskId from a "Generate Music" task or an "Extend Music" 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: Unauthorized - 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"
