Submit Task(Product Background)

post

https://api.topview.ai/v2/product_anyShoot/product_background/task/submit

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

mode

string

enum

required

Defaults to prompt

When mode=image, either templateId or templateImageFileId must not be empty; 2. When mode=prompt, prompt must not be empty.

Allowed:

productImageWithoutBackgroundFileId

string

required

Defaults to e5ea811a6fb646ba9e0354232e8b97a4

Use the Common Task - remove background interface to convert product images into images without backgrounds. 2. Upload the background-free product images to S3.

templateId

string

Get values from the Template List interface. 2. When mode=image, either templateId or templateImageFileId must not be empty.

templateImageFileId

string

Upload the local model image to S3. 2. When mode=image, either templateId or templateImageFileId must not be empty.

prompt

string

When mode=prompt, prompt cannot be empty.

aspectRatio

string

enum

Defaults to 1:1

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

Allowed:

location

array

required

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

location*

productSimilarity

string

enum

Defaults to natural

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

Allowed:

noticeUrl

string

Headers

Topview-Uid

string

required

Defaults to <your-topview-uid>

Authorization

string

required

Defaults to Bearer <your-api-key>

Response

200

Successful response

Language

Loading…

Response

Click Try It! to start a request and see the response here!