Usage Guide
- Use this endpoint to check the status of a video generation task
- Access the video URL once generation is complete
- Track processing progress and any errors that may have occurred
Status Descriptions
PENDING
: Task is waiting to be processedSUCCESS
: Video generation completed successfullyCREATE_TASK_FAILED
: Failed to create the video generation taskGENERATE_MP4_FAILED
: Failed during video file creation
Developer Notes
- The video URL is only available in the response when status is
SUCCESS
- Error codes and messages are provided for failed tasks
- Videos are retained for 14 days after successful generation
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 video generation task to retrieve. This is the taskId returned when creating the music video generation task.
Response
Success
Status code Response status code
- 200: Success - Request has been processed successfully
- 400: Format Error - The parameter is not in a valid JSON format
- 401: Unauthorized - Authentication credentials are missing or invalid
- 402: Insufficient Credits - Account does not have enough credits to perform the operation
- 404: Not Found - The requested resource or endpoint does not exist
- 409: Conflict - WAV record already exists
- 422: Validation Error - The request parameters failed validation checks
- 429: Rate Limited - Request limit has been exceeded for this resource
- 455: Service Unavailable - System is currently undergoing maintenance
- 500: Server Error - An unexpected error occurred while processing the request
Available options:
200
, 400
, 401
, 402
, 404
, 409
, 422
, 429
, 455
, 500
Example:
0
Status message Error message when code != 200
Example:
"success"