Status Descriptions
- 0: GENERATING - Task is currently being processed
- 1: SUCCESS - Task completed successfully
- 2: CREATE_TASK_FAILED - Failed to create the task
- 3: GENERATE_FAILED - Task creation succeeded but generation failed
- 4: CALLBACK_FAILED - Generation succeeded but callback failed
Important Notes
- Generated videos are stored temporarily and may expire
- Check the response object for generated video URLs when status is SUCCESS
- Use polling with reasonable intervals (recommended: 30 seconds) to avoid rate limiting
Usage Examples
Response Field Details
Current status of the video generation task:
Value | Status | Description |
---|---|---|
0 | GENERATING | Task is being processed |
1 | SUCCESS | Completed successfully |
2 | CREATE_TASK_FAILED | Failed to create task |
3 | GENERATE_FAILED | Generation failed |
4 | CALLBACK_FAILED | Callback delivery failed |
Generation results (only present when successFlag = 1):
Original request parameters in JSON string format, useful for debugging and audit trails
Task creation timestamp (Unix milliseconds)
Task completion timestamp (Unix milliseconds), only present when task is finished
Error code when task fails (successFlag = 2 or 3)
Detailed error message when task fails
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 video generation 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
- 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
- 501: Generation Failed - Video generation task failed
Available options:
200
, 401
, 404
, 422
, 429
, 455
, 500
, 501
Error message when code != 200
Example:
"success"