Skip to main content
POST

Authorizations

Authorization
string
header
required

All APIs require Bearer Token authentication

Get API Key:

Visit API Key Management Page to get your API Key

Add to request header:

Body

application/json
model
enum<string>
default:gpt-image-2-beta
required

Image generation model name

Available options:
gpt-image-2-beta
Example:

"gpt-image-2-beta"

prompt
string
required

Prompt describing the image you want to generate, or describing how to edit the input image. Limited to 2000 tokens

Maximum string length: 2000
Example:

"A beautiful colorful sunset over the ocean"

size
string
default:auto

Generated image size. Supports two modes:

1. auto (default)

The model automatically determines the output size. In this mode, the resolution field is ignored and treated as 1K.

2. Ratio (must be used with resolution="1K")

  • 1:1: Square
  • 3:2 / 2:3: Landscape / Portrait
  • 4:3 / 3:4: Landscape / Portrait
  • 5:4 / 4:5: Common social media
  • 16:9 / 9:16: Widescreen landscape / portrait
  • 21:9 / 9:21: Ultra-wide landscape / portrait
  • 2:1 / 1:2: Landscape / Portrait
  • 3:1 / 1:3: Panorama landscape / portrait (maximum aspect ratio)

Note: Explicit pixel sizes (such as 1024x1024) are not currently supported. For explicit pixel control, use gpt-image-2.

Example:

"16:9"

resolution
enum<string>
default:1K

Resolution tier. Effective only when size is a ratio. Currently only 1K is supported.

When ignored:

  • When size=auto, this field is ignored and treated as 1K (no need to pass this parameter)

Landscape / square output dimensions (portrait dimensions are the landscape width/height swapped):

Note: 2K / 4K are not currently supported. For higher resolution, use gpt-image-2.

Available options:
1K
Example:

"1K"

image_urls
string<uri>[]

Reference image URL list for image-to-image and image editing features

Notes:

  • Up to 16 reference images per request
  • Supported formats: .jpeg, .jpg, .png, .webp
  • Image URLs must be directly accessible by the server, or URLs that trigger direct download (typically URLs ending with image extensions like .png, .jpg)
Maximum array length: 16
Example:
callback_url
string<uri>

HTTPS callback URL for task completion

Callback Timing:

  • Triggered when task is completed, failed, or cancelled
  • Sent after billing confirmation

Security Restrictions:

  • HTTPS protocol only
  • Internal IP addresses are prohibited (127.0.0.1, 10.x.x.x, 172.16-31.x.x, 192.168.x.x, etc.)
  • URL length must not exceed 2048 characters

Callback Mechanism:

  • Timeout: 10 seconds
  • Maximum 3 retries after failure (at 1/2/4 seconds after failure)
  • Callback response format is consistent with task query API
  • 2xx status code is considered successful, other codes trigger retry
Example:

"https://your-domain.com/webhooks/image-task-completed"

Response

Image task created successfully

created
integer

Task creation timestamp

Example:

1757156493

id
string

Task ID

Example:

"task-unified-1757156493-imcg5zqt"

model
string

Actual model name used

Example:

"gpt-image-2-beta"

object
enum<string>

Task object type

Available options:
image.generation.task
progress
integer

Task progress percentage (0-100)

Required range: 0 <= x <= 100
Example:

0

status
enum<string>

Task status

Available options:
pending,
processing,
completed,
failed
Example:

"pending"

task_info
object

Async task information

type
enum<string>

Task output type

Available options:
text,
image,
audio,
video
Example:

"image"

usage
object

Usage and billing information