Usage Guide
- Use this interface to check Cover generation task status
- Access generated cover image URLs upon completion
- Track processing progress and any errors that may occur
- Supports polling to get task results, recommend querying every 30 seconds
Developer Notes
- Cover image URLs are only available upon successful completion
- Error codes and messages are provided for failed tasks
- After successful processing, cover images are retained for 14 days
- Usually generates 2 different style cover images
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 Cover generation task to retrieve. This is the taskId returned when creating the Cover generation task.
Response
Success
Status code Response status code
- 200: Success - Request processed successfully
- 400: Format error - Parameters are not in valid JSON format
- 401: Unauthorized - Authentication credentials missing or invalid
- 402: Insufficient credits - Account doesn't have enough credits for this operation
- 404: Not found - Requested resource or endpoint doesn't exist
- 409: Conflict - Cover record already exists
- 422: Validation error - Request parameters failed validation checks
- 429: Rate limited - Request rate limit exceeded for this resource
- 455: Service unavailable - System currently undergoing maintenance
- 500: Server error - Unexpected error occurred while processing request
Available options:
200
, 400
, 401
, 402
, 404
, 409
, 422
, 429
, 455
, 500
Example:
200
Status message Error message when code != 200
Example:
"success"