Authorizations
##All APIs require Bearer Token authentication##
Get API Key:
Visit API Key Management Page to get your API Key
Add to request header when using:
Authorization: Bearer YOUR_API_KEYBody
Image generation model name
gpt-4o-image "gpt-4o-image"
Prompt describing the desired image to generate, or describing how to edit the input image
1000"A beautiful sunset over the ocean with vibrant colors"
Size of the generated image, supports two formats:
Simplified ratio format:
- Supports 
1:1,2:3,3:2values 
Pixel format:
- Supports 
1024x1024,1024x1536,1536x1024values 
1:1, 2:3, 3:2, 1024x1024, 1024x1536, 1536x1024 "1024x1024"
Number of images to generate, currently only supports 1, 2, 4 values.
Note:
- A single request will be pre-charged based on the value of 
n, and the actual charge will be based on the number of generated images 
1
Reference image URL list for image-to-image and image editing features
Note:
- Maximum number of input images per request: 
5images - Single image size: no more than 
10MB - Supported file formats: 
.jpeg,.jpg,.png,.webp - Image URLs must be directly accessible by the server, or the image URL should directly download when accessed (typically these URLs end with image file extensions, such as 
.png,.jpg) 
[
  "https://example.com/image1.png",
  "https://example.com/image2.png"
]Mask image URL
Note:
- When using this parameter, the mask image and reference image must be in PNG format with the same dimensions
 - Mask image size cannot exceed 4MB
 - This parameter cannot be used when the 
image_urlsparameter contains more than 1 image 
"https://example.com/mask.png"
HTTPS callback address after task completion
Callback Timing:
- Triggered when task is completed, failed, or cancelled
 - Sent after billing confirmation is completed
 
Security Restrictions:
- Only HTTPS protocol is supported
 - Callback to internal IP addresses is prohibited (127.0.0.1, 10.x.x.x, 172.16-31.x.x, 192.168.x.x, etc.)
 - URL length must not exceed 
2048characters 
Callback Mechanism:
- Timeout: 
10seconds - Maximum 
3retries on failure (retries after1second/2seconds/4seconds) - Callback response body format is consistent with the task query API response format
 - Callback address returning 2xx status code is considered successful, other status codes will trigger retry
 
"https://your-domain.com/webhooks/image-task-completed"
Response
Image task created successfully
Task creation timestamp
1757156493
Task ID
"task-unified-1757156493-imcg5zqt"
Actual model name used
"gpt-4o-image"
Specific task type
image.generation.task Task progress percentage (0-100)
0 <= x <= 1000
Task status
pending, processing, completed, failed "pending"
Asynchronous task information
Task output type
text, image, audio, video "image"
Usage and billing information