4o Image Generation Callbacks

When the 4o Image task is completed, the system will send the result to your provided callback URL via POST request

When you submit an image generation task to the 4o Image API, you can use the 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

NOTE

The callback mechanism eliminates the need to poll the API for task status. The system will proactively push task completion results to your server.

Webhook Security: To ensure the authenticity and integrity of callback requests, we strongly recommend implementing webhook signature verification. See our Webhook Verification Guide for detailed implementation steps.

Callback Timing

The system will send callback notifications in the following situations:

4o image generation task completed successfully

4o image 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 your callBackUrl in the following format:

Success Callback

Failure Callback

{
  "code": 200,
  "msg": "Gpt4o-image generated successfully.",
  "data": {
    "taskId": "task12345",
    "info": {
      "result_urls": [
        "https://example.com/result/image1.png"
      ]
    }
  }
}

Status Code Description

Parameter Description

Parameter	Type	Required	Description
`code`	integer	Yes	Callback status code indicating task processing result
`msg`	string	Yes	Status message providing detailed status description
`data.taskId`	string	Yes	Task ID, consistent with the taskId returned when you submitted the task
`data.info`	object	No	Image generation result information, returned on success
`data.info.result_urls`	array	No	List of generated image URLs, returned on success with accessible download links

Status Code Details

Status Code	Description
200	Success - Image generation completed successfully
400	Bad Request - Image content in filesUrl violates content policy, image size exceeds maximum limit, unable to process provided image file, content flagged by OpenAI as violating policies
451	Download Failed - Unable to download image from the provided filesUrl
500	Server Error - Please try again later, failed to get user token, failed to generate image, GPT 4O failed to edit the picture

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 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

Image Processing: Image download and processing should be done in asynchronous tasks to avoid blocking callback response

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

Please ensure the stability of callback processing logic to avoid callback failures due to exceptions

Generated image URLs may have time limits, recommend downloading and saving promptly

Pay attention to content policy compliance to avoid generation failures due to policy violations

Troubleshooting

If you do not receive callback notifications, please check the following:

Network Connection Issues

Server Response Issues

Content Format Issues

Image Processing Issues

Alternative Solution

If you cannot use the callback mechanism, you can also use polling:

Poll Query Results

Use the get 4o image details endpoint to regularly query task status. We recommend querying every 30 seconds.

4o Image Generation Callbacks

Callback Mechanism Overview#

Callback Timing#

Callback Method#

Callback Request Format#

Status Code Description#

Parameter Description#

Status Code Details#

Callback Reception Examples#

Best Practices#

Troubleshooting#

Alternative Solution#

Callback Mechanism Overview

Callback Timing

Callback Method

Callback Request Format

Status Code Description

Parameter Description

Status Code Details

Callback Reception Examples

Best Practices

Troubleshooting

Alternative Solution