Submit Task

post

https://api.topview.ai/v1/common_task/image_edit/task/submit

Submit an image editing task. The system will apply AI-powered edits to the reference images based on the provided prompt and model specifications. For sample requests and model descriptions, please refer to the documentation API Usage

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

model

string

required

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

prompt

string

required

Edit prompt (required) describing the editing modifications to apply

inputImageFileIds

array of strings

required

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

inputImageFileIds*

aspectRatio

string

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

generateCount

integer

1 to 4

Number of edited images to generate (1-4)

resolution

string

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

boardId

string

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

noticeUrl

string

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.

Headers

Topview-Uid

string

required

User ID

Authorization

string

required

API Key for authentication (Bearer token)

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Task submitted successfully