Skip to main content
POST
Edit Image

Headers

Request Body

Data Types

Canvas

CanvasImg

Mask

Polygon

Example Request

Response

Returns a task object containing the task information.
This is the initial success response. Use the job_id to check the task status via the Get Task endpoint to retrieve the completed result with image URLs.

Authorizations

x-api-key
string
header
required

API key for authentication

Body

application/json
jobId
string<uuid>
required

ID of the original image generation task

imageNo
integer
required

Image number to edit (0, 1, 2, or 3)

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

0

canvas
object
required

Target canvas dimensions

imgPos
object
required

Image position relative to canvas

remixPrompt
string
required

Text prompt for the edit

Required string length: 1 - 8192
callback
string<uri>

Callback URL for task completion notifications

Response

Edit task created successfully