Submit Task(Product Model)

post

https://api.topview.ai/v3/product_anyShoot/product_model/task/submit

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Response

Field	Type	Description
code	String	Response code indicating success.
message	String	Message describing the response.
taskId	String	Unique identifier for the task.
status	String	Status of the task, indicating success or failure.
errorMsg	Null	Error message if applicable (null if no error).
subTaskId	String	Unique identifier for the sub-task.
noticeUuid	String	Unique identifier for the notice.

Body Params

productImageFileId

string

required

Defaults to ce15c187fdc14457ab6c9045c3e3faa0

Upload the local image to S3.

productMaskFileId

string

Needs to be generated by the user.[Must match the dimensions of the productImageFileId]

templateId

string

Obtain the parameter value from the Template List interface.templateId and templateImageFileId cannot be empty at the same time; if both templateId and templateImageFileId exist, templateImageFileId will be given priority.

templateImageFileId

string

Defaults to 95b1f133c91e40f281a3de22c5bd1637

Upload the local image to S3.templateId and templateImageFileId cannot be empty at the same time; if both templateId and templateImageFileId exist, templateImageFileId will be given priority.

templateMaskFileId

string

required

Defaults to 8144698c4007473fbc1137143cac2437

generatingCount

string

enum

required

Number of images to generate: 1-4.

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