Skip to main content
POST
  • Unified image generation API
  • Use model parameter to select gpt-4o-image model
  • Supports text-to-image, image-to-image, and image editing
  • Async task management, query results by task ID
Important Change: For better performance and cost control, we no longer support passing base64 image data directly in image_urls. Please use the Upload Image API first to upload images and get URLs, then call this endpoint.

Authorizations

string
required
All endpoints require Bearer Token authenticationGet your API Key from the API Key Management PageAdd to request header:

Body

string
default:"gpt-4o-image"
required
Image generation model nameExample: "gpt-4o-image"
string
required
Text description for image generationMaximum 1000 characters
string
default:"1:1"
Image aspect ratioSupported formats:
  • 1:1 - Square (default)
  • 2:3 - Portrait
  • 3:2 - Landscape
integer
default:1
Number of images to generateSupports 1, 2, 4. Charges will be pre-deducted based on the numberDefault: 1⚠️ Note: Must enter a plain number (e.g., 1), do not use quotes or it will cause an error
string[]
Reference image URL list for image-to-image or image editing⚠️ URL format only (base64 no longer supported)
  • Publicly accessible image URL (http:// or https://)
  • You can use the Upload Image API to upload local images and get URLs
Limitations:
  • Maximum 5 images
  • Single image up to 10MB
  • Supported formats: jpeg, jpg, png, webp
string
Mask image URL (for image editing)
  • Must be PNG format
  • Size must match the reference image
  • Maximum 4MB

Response

string
Unique task identifier for status queries
string
Object type, always generation.task
string
Model name used
string
Task status
  • queued - Queued for processing
  • in_progress - Processing
  • completed - Successfully completed
  • failed - Failed
integer
Task progress percentage (0-100)
integer
Task creation timestamp (Unix timestamp)
object
Task metadata