callBackUrl parameter. After the task is completed, the system will automatically push the results to your specified address.
Callback Mechanism Overview
The callback mechanism eliminates the need for you to poll the API to query task status. The system will actively push task completion results to your server.
Callback Timing
The system will send callback notifications in the following situations:- Image generation or editing task completed successfully
- Image generation or editing task failed
- Error occurred during task processing
Callback Method
- HTTP Method: POST
- Content Type: application/json
- Timeout Setting: 15 seconds
Callback Request Format
After task completion, 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 - Image generation successful |
| 400 | Failed - Your prompt was flagged for violating content policy |
| 500 | Failed - Internal error, please try again later |
| 501 | Failed - Image generation task failed |
Status message providing detailed status description
Task ID, consistent with the taskId returned when you submitted the task
Generated image URL on our server. Only exists on success.
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 callback URL uses HTTPS protocol for secure data transmission
- Verify Source: Verify the legitimacy of request sources in callback handling
- Idempotent Processing: The same taskId may receive multiple callbacks, ensure processing logic is idempotent
- Quick Response: Callback handling should return 200 status code quickly to avoid timeout
- Asynchronous Processing: Complex business logic should be processed asynchronously to avoid blocking callback response
- Timely Download: Download image files promptly after receiving successful callbacks
Important Reminders
- Callback URL must be a publicly accessible address
- Server must respond within 15 seconds, otherwise it will be considered timeout
- After 3 consecutive retry failures, the system will stop sending callbacks
- Ensure stability of callback handling logic to avoid callback failures due to exceptions
- Need to handle multiple error status codes (400, 500, 501), implement complete error handling
- Pay attention to content policy violation issues and adjust prompts timely
Troubleshooting
If you haven’t received callback notifications, please check the following:Network Connection Issues
Network Connection Issues
- Confirm callback URL is accessible from the public internet
- Check firewall settings to ensure inbound requests are not blocked
- Verify domain name resolution is correct
Server Response Issues
Server Response Issues
- Ensure server returns HTTP 200 status code within 15 seconds
- Check server logs for error information
- Verify interface path and HTTP method are correct
Content Format Issues
Content Format Issues
- Confirm received POST request body is in JSON format
- Check if Content-Type is application/json
- Verify JSON parsing is correct
Image Processing Issues
Image Processing Issues
- Confirm image URL is accessible
- Check image download permissions and network connection
- Verify image save path and permissions
- Implement reasonable image download and storage logic
Content Policy Issues
Content Policy Issues
- Review content policy violation prompts in error messages
- Adjust flagged prompt content
- Ensure prompts comply with platform content guidelines
- Check for sensitive or inappropriate content
Task Failure Issues
Task Failure Issues
- Check if generation parameters are reasonable
- Verify input image format and quality
- Confirm prompt length and format
- Consider adjusting generation parameters and retry
Alternative Solution
If you cannot use the callback mechanism, you can also use polling:Polling Query Results
Use the get task details interface to periodically query task status, recommended every 30 seconds.