Skip to main content
POST

Authorizations

Authorization
string
header
required

API Key authentication. Format: Bearer YOUR_API_KEY.

Body

application/json
prompt
string
required

Editing instruction describing the desired transformation

Minimum string length: 1
Example:

"Convert this photo to an oil painting style"

image
string[]
required

Input image URLs. Pass 1–3 images; all images are used together as reference context for the edit.

Required array length: 1 - 3 elements

Image URL (e.g. https://example.com/image.jpg).

Example:
aspectRatio
enum<string>
default:1:1

Output image aspect ratio

Available options:
1:1,
2:3,
3:2,
3:4,
4:3,
4:5,
5:4,
9:16,
16:9,
21:9
Example:

"16:9"

Response

Task submitted successfully

code
integer
required

Response code, 0 indicates success

Example:

0

message
string
required

Response message

Example:

"success"

data
object
required

Detailed data about the submitted asynchronous task.