Skip to main content
GET
Get Lyrics Generation Details

Status Descriptions

  • PENDING: Task is waiting to be processed
  • SUCCESS: Lyrics generated successfully
  • CREATE_TASK_FAILED: Failed to create the task
  • GENERATE_LYRICS_FAILED: Failed to generate lyrics
  • CALLBACK_EXCEPTION: Error occurred during callback
  • SENSITIVE_WORD_ERROR: Content contains prohibited words

Developer Notes

  • Use this endpoint to check task status instead of waiting for callbacks
  • This returns all generated lyrics variations from a single task
  • Each lyrics variation includes a title and complete lyrics text

Authorizations

Authorization
string
header
required

🔑 API Authentication

All endpoints require authentication using Bearer Token.

Get API Key

  1. Visit the API Key Management Page to obtain your API Key

Usage

Add to request headers:

⚠️ 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 from the management page

Query Parameters

taskId
string
required

The task ID returned from the Generate Lyrics endpoint. Used to retrieve detailed information about a specific lyrics generation task.

Response

Request successful

code
enum<integer>

Status Codes

  • ✅ 200 - Request successful
  • ⚠️ 400 - Invalid parameters
  • ⚠️ 401 - Unauthorized access
  • ⚠️ 404 - Invalid request method or path
  • ⚠️ 405 - Rate limit exceeded
  • ⚠️ 413 - Theme or prompt too long
  • ⚠️ 429 - Insufficient credits
  • ⚠️ 430 - Your call frequency is too high. Please try again later.
  • ⚠️ 455 - System maintenance
  • ❌ 500 - Server error
Available options:
200,
400,
401,
404,
405,
413,
429,
430,
455,
500
Example:

200

msg
string

Error message when code != 200

Example:

"success"

data
object