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:- Video modification task completed successfully
- Video modification 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 modification completed successfully |
500 | Failed - Video modification task failed |
Status message providing detailed status description
Task ID, consistent with the taskId returned when you submitted the task
Original request parameters in JSON format, including the prompt, video URL, callback URL, and watermark settings
Generated video URLs. Only present on successful completion (code 200).
Callback Reception Examples
Here are example codes for receiving callbacks in popular programming languages: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 taskId 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
- Timely Download: Download generated videos promptly as they may expire after some time
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
- Generated video URLs may expire - download immediately upon receiving callback
- Please ensure the stability of callback processing logic to avoid callback failures due to exceptions
- Need to handle both success and failure status codes for complete error handling
- Large video files may take time to download - implement appropriate timeout settings
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
- Handle video download timeouts and retry logic
- Implement checksum validation for large video files
Task Failure Issues
Task Failure Issues
- Check if video modification parameters are reasonable
- Verify input video format and quality
- Confirm prompt length and format
- Consider adjusting modification parameters and retry
- Review error messages in promptJson for debugging
Alternative Solution
If you cannot use the callback mechanism, you can also use polling:Poll Query Results
Use the get Luma modify details endpoint to regularly query task status. We recommend querying every 30 seconds for video generation tasks.