callBackUrl parameter to set a callback URL. The system will automatically push the results to your specified address when the task is completed.
Callback Mechanism Overview
The callback mechanism eliminates the need to poll the API for task status. The system will proactively push task completion results to your server.
Callback Timing
The system will send callback notifications in the following situations:- AI video generation task completed successfully
- AI video generation task failed
- Errors occurred during task processing
Callback Method
- HTTP Method: POST
- Content Type: application/json
- Timeout Setting: 15 seconds
Callback Request Format
When the task is completed, the system will send a POST request to yourcallBackUrl in the following format:
Status Code Description
Callback status code indicating task processing result:
| Status Code | Description |
|---|---|
| 200 | Success - Video generation completed successfully |
| 400 | Client Error - Inappropriate content, format error, quota limit, or other client-side issues |
| 500 | Server Error - Internal server error during video generation |
Status message providing detailed status description. Common error messages include:
- “Inappropriate content detected. Please replace the image or video.”
- “Incorrect image format.”
- “Please try again later. You can upgrade to Standard membership to start generating now.”
- “Reached the limit for concurrent generations.”
- “Unsupported width or height. Please adjust the size and try again.”
- “Your prompt was caught by our AI moderator. Please adjust it and try again!”
Task ID, consistent with the taskId returned when you submitted the task
Generated video ID for identification and tracking
Accessible video URL, valid for 14 days. Empty on failure.
Cover image URL of the generated video. Empty on failure.
Callback Reception Examples
Here are example codes for receiving callbacks in popular programming languages:- Node.js
- Python
- PHP
Best Practices
Callback URL Configuration Recommendations
- Use HTTPS: Ensure your callback URL uses HTTPS protocol for secure data transmission
- Verify Source: Verify the legitimacy of the request source in callback processing
- Idempotent Processing: The same task_id may receive multiple callbacks, ensure processing logic is idempotent
- Quick Response: Callback processing should return a 200 status code as quickly as possible to avoid timeout
- Asynchronous Processing: Complex business logic should be processed asynchronously to avoid blocking callback response
- Immediate Download: Video URLs are valid for only 14 days, download and save files immediately upon success
Important Reminders
- Callback URL must be a publicly accessible address
- Server must respond within 15 seconds, otherwise it will be considered a timeout
- If 3 consecutive retries fail, the system will stop sending callbacks
- Video URLs expire after 14 days - download immediately upon receiving callback
- Please ensure the stability of callback processing logic to avoid callback failures due to exceptions
- Handle both video_url and image_url fields for complete media management
- Pay attention to error messages for specific failure reasons (content moderation, format issues, quotas)
Troubleshooting
If you do not receive callback notifications, please check the following:Network Connection Issues
Network Connection Issues
- Confirm that the callback URL is accessible from the public network
- Check firewall settings to ensure inbound requests are not blocked
- Verify that domain name resolution is correct
Server Response Issues
Server Response Issues
- Ensure the server returns HTTP 200 status code within 15 seconds
- Check server logs for error messages
- Verify that the interface path and HTTP method are correct
Content Format Issues
Content Format Issues
- Confirm that the received POST request body is in JSON format
- Check that Content-Type is application/json
- Verify that JSON parsing is correct
Video Processing Issues
Video Processing Issues
- Confirm that video URLs are accessible
- Check video download permissions and network connections
- Verify video save paths and permissions
- Note the 14-day URL expiration - implement immediate download logic
- Handle both video and cover image downloads
Content Moderation Issues
Content Moderation Issues
- Review error messages for content policy violations
- Adjust prompts if flagged by AI moderator
- Ensure uploaded images/videos meet content guidelines
- Check for inappropriate content detection messages
Alternative Solution
If you cannot use the callback mechanism, you can also use polling:Poll Query Results
Use the get AI video details endpoint to regularly query task status. We recommend querying every 30 seconds.
