Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer YOUR_API_KEY. Manage keys in API Keys.

Body

application/json
model
string
required

Also accepts the legacy alias openai/gpt-image-2.

Allowed value: "gpt-image-2"
prompt
string
required

Image generation or edit prompt.

Required string length: 1 - 32000
images
object[]

Reference images. Omit or pass an empty array for text-to-image.

Maximum array length: 6
resolution
enum<string>
default:1K

Output resolution tier.

Available options:
1K,
2K,
4K
aspect_ratio
enum<string>
default:1:1

Output aspect ratio.

Available options:
1:1,
3:2,
2:3,
16:9,
9:16,
4:3,
3:4,
21:9,
9:21
num
integer
default:1

Output count.

Required range: 1 <= x <= 4
quality
enum<string>
default:medium

Quality tier.

Available options:
low,
medium,
high
background
enum<string>

Background preference.

Available options:
auto,
opaque,
transparent

Response

Task accepted.

task_id
string
required

Task ID to poll.

model
string
required

Echoes the supplied model ID or legacy alias.

created_at
string<date-time>
required

Task creation time (UTC).

request_id
string
required

Request ID.