v1

latestOpenAPI 3.0.32026-07-241112213.6 KB

Copy of New Endpoint

This is your first endpoint! Edit this page to start documenting your API.

post/v3/product_avatar/task/image_replace/submit

Request body

generateImageMode'auto' | 'manual' required
avatarIdstring
  1. avatarId and templateImageFileId cannot be both empty;</br>
  2. Obtain parameter values from the interface Public product avatar Query.</br>
  3. If both avatarId and templateImageFileId are passed, templateImageFileId will be used instead of avatarId
templateImageFileIdstring required
  1. avatarId and templateImageFileId cannot be both empty;</br>
  2. Obtain parameter values from the interface Public product avatar Query.</br>
  3. If both avatarId and templateImageFileId are passed, templateImageFileId will be used instead of avatarId</br>

Example: c62216b7e35e4e8598edc29a4041c7b6

productImageWithoutBackgroundFileIdstring required
  1. You can use the remove background interface to convert the product image into a background-free product image;</br>
  2. Upload the background-free product image to S3; for detailed operations, see the file upload interface .

Example: 722e4c0ebdc148e295df9fe30c3160bd

imageEditPromptstring required

Images will only be generated using imageEditPrompt in generateImageMode=auto mode.</br>

Example: Replace the item in the hand of the person in Picture 1 with the one in Picture 2. Keep the composition position and gesture of the person in Picture 1 unchanged, and ensure that the features, appearance and details of the item in Picture 2 remain exactly the same after the change.

locationnumber[]

The location parameter will only be used in generateImageMode=manual mode. Location parameter documentation. Detail for document location-parameters-document

noticeUrlstring
boardIdstring

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

Response

Successful response

codestring required

200:success Other:fail

messagestring required