Sign in

v1

latestOpenAPI 3.0.32026-07-241112213.6 KB

New Endpoint

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

post/v3/product_anyShoot/product_background/task/submit

Request body

mode'image' | 'prompt' required
  1. When mode=image, either templateId or templateImageFileId must not be empty; 2. When mode=prompt, prompt must not be empty.
productImageWithoutBackgroundFileIdstring required
  1. Use the Common Task - remove background interface to convert product images into images without backgrounds. 2. Upload the background-free product images to S3.
templateIdstring
  1. Get values from the Template List interface. 2. When mode=image, either templateId or templateImageFileId must not be empty.
templateImageFileIdstring
  1. Upload the local model image to S3. 2. When mode=image, either templateId or templateImageFileId must not be empty.
promptstring

When mode=prompt, prompt cannot be empty.

aspectRatio'9:16' | '3:4' | '1:1' | '4:3' | '16:9'

Default value: 1:1. Optional values: 9:16, 3:4, 1:1, 4:3, 16:9.

locationstring required

The location parameter will only be used in generateImageMode=manual mode. Location parameter documentation

productSimilarity'natural' | 'creative'

Default is natural.1. natural: 98% restoration level 2. creative: 90% restoration level

noticeUrlstring

NoticeUrl. Please refer to the API documentation for details NoticeUrl

Response

codestring required

200:success Other:fail

messagestring required