Usage Guide
- Use this endpoint to check the status of a lyrics generation task
- Retrieve generated lyrics content once the task is complete
- Track task progress and access any error information if generation failed
Status Descriptions
PENDING: Task is waiting to be processedSUCCESS: Lyrics generated successfullyCREATE_TASK_FAILED: Failed to create the taskGENERATE_LYRICS_FAILED: Failed during lyrics generationCALLBACK_EXCEPTION: Error occurred during callbackSENSITIVE_WORD_ERROR: Content filtered due to sensitive words
Developer Notes
- Successful tasks will include multiple lyrics variations
- Each lyrics set includes both content and a suggested title
- Error codes and messages are provided for failed tasks
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 lyrics generation task to retrieve. This is the taskId returned when creating the lyrics generation task.
Response
Request successful
Response status code
- 200: Success - Request has been processed successfully
- 400: Please try rephrasing with more specific details or using a different approach. Song Description contained artist name: Song Description flagged for moderation Unable to generate lyrics from song description
- 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 Internal Error - Please try again later.
Available options:
200, 400, 401, 404, 422, 451, 455, 500 Error message when code != 200
Example:
"success"
