Sign in

v1

latestOpenAPI 3.0.32026-07-241112213.6 KB
Image Edit

Submit Task

Submit an image editing task. The system will apply AI-powered edits to the reference images based on the provided prompt and model specifications.

post/v1/common_task/image_edit/task/submit

Headers

Topview-Uidstring required

User ID

Authorizationstring required

API Key for authentication (Bearer token)

Request body

modelstring required

Model name (required), e.g., 'Nano Banana 2', 'Seedream 5.0'

promptstring required

Edit prompt (required) describing the editing modifications to apply

inputImageFileIdsstring[] required

Reference image file IDs (required). These are the file IDs of images to be edited.

aspectRatiostring

Aspect ratio, e.g., '1:1', '16:9', '9:16', '4:3', 'auto' (auto means follow input image ratio)

generateCountinteger

Number of edited images to generate (1-4)

resolutionstring

Resolution, e.g., '1K', '2K', '4K', '512p'

boardIdstring

Board ID (optional). If provided, the task will be associated with this board.

noticeUrlstring

Callback URL for task completion notifications (optional). The system will send a POST request to this URL when the task is completed with task status and results.

Example request

{
  "aspectRatio": "auto",
  "generateCount": 1,
  "resolution": "1K"
}

Response

Task submitted successfully

codestring

Response code

messagestring

Response message

Example response

{
  "code": "200",
  "message": "Success"
}