Skip to main content
POST
Poll the returned task URL to retrieve the PNG. Query Task Result

Authorizations

Authorization
string
header
required

API Key authentication. Format: Bearer YOUR_API_KEY.

Body

application/json

Apply a prompt-guided edit to one source image and return one PNG.

prompt
string
required

Describe the edit to apply. The platform limit is 32,000 UTF-8 bytes.

Required string length: 1 - 32000
Example:

"Keep the subjects and composition, and give the background a warm sunset color grade."

images
(string<uri> | object)[]
required

Provide exactly one publicly accessible HTTP or HTTPS URL for a JPEG or PNG. Use a URL string or an object with an image_url string.

Required array length: 1 element
Pattern: ^https?://
Example:

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.