Skip to main content
GET
get task status
All async endpoints (generate, lyrics, mashupLyrics, concat, remaster, mp4, wav, etc.) return a taskId. Use this endpoint to poll the task until it reaches a terminal status (success, failed, or timeout).

Task Status Values

Polling Best Practices

Use exponential backoff when polling: start with 2-3 second intervals, then gradually increase. Music generation tasks typically take 30-120 seconds depending on the task type.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

taskId
string
required

Task ID

Example:

"1212"

Response

200 - application/json

The task status information

taskId
string
required

Task id.

Example:

"task_1731a9b2f4"

status
enum<string>
required

task status

Available options:
queued,
ready,
running,
stream,
awaiting,
success,
failed,
timeout
createdAt
string<date-time>
required

Task created time (UTC).

Example:

"2025-08-18T02:30:00.000Z"

failReason
string

Failure reason when status=FAILED.

Example:

"Audio source not found."

failCode
number

Failure code when status=FAILED.

Example:

4001

data
object

Data associated with the task.

finishAt
string<date-time>

Task finished time (UTC).

Example:

"2025-08-18T02:35:00.000Z"