submit task

Developing

POST

/v1/product_anyShoot/task/submit

Request

Header Params

Authorization

string

optional

Topview-Uid

string

optional

Body Params application/json

productImageFileId

string

required

Product image fileId

productMaskFileId

string

optional

Product mask fileId. [Need to be consistent in size with the original image] If uploaded, users need to generate it themselves

templateId

string

optional

TemplateId

templateImageFileId

string

optional

Template image fileId. TemplateId and Template image fileId cannot be empty at the same time. If both the templateId and the template image FileId exist, the templateImageFileId will be used as the priority.

templateMaskFileId

string

required

Template mask fileId. [Need to be consistent in size with the original image] Users need to generate it themselves

mode

string

required

Mode。easy/advanced

easyModePrompt

string

optional

Easy mode prompt

generatingCount

integer

required

Generating Count。Support 1 to 4

noticeUrl

string

optional

Please refer to the API documentation for details

Example

{
    "productImageFileId": "string",
    "productMaskFileId": "string",
    "templateId": "string",
    "templateImageFileId": "string",
    "templateMaskFileId": "string",
    "mode": "string",
    "easyModePrompt": "string",
    "generatingCount": 0,
    "noticeUrl": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.topview.ai/v1/product_anyShoot/task/submit' \
--header 'Authorization;' \
--header 'Topview-Uid;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productImageFileId": "string",
    "productMaskFileId": "string",
    "templateId": "string",
    "templateImageFileId": "string",
    "templateMaskFileId": "string",
    "mode": "string",
    "easyModePrompt": "string",
    "generatingCount": 0,
    "noticeUrl": "string"
}'

Responses

🟢200OK

application/json

Body

code

string

required

message

string

required

result

object

required

taskId

string

required

status

string

required

errorMsg

string

required

Example

{
    "code": "string",
    "message": "string",
    "result": {
        "taskId": "string",
        "status": "string",
        "errorMsg": "string"
    }
}

Modified at 2025-06-07 13:55:48

query task