Topview-api

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

商品图FileId

productMaskFileId

string

optional

商品遮罩图FileId。【需要与原图的尺寸一致】若上传需要用户自行生成

templateId

string

optional

模板id

templateImageFileId

string

optional

模板图片FileId。模板id和模板图片FileId，不能同时为空；若模板id和模板图片FileId同时存在，则优先使用模板图片FileId

templateMaskFileId

string

required

模板图片遮罩FileId。【需要与原图的尺寸一致】需要用户自行生成

mode

string

required

合成模式。easy/advanced

easyModePrompt

string

optional

easy模式文本

generatingCount

integer

required

生成数量。1-4张

noticeUrl

string

optional

回调地址。详情看api文档

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:53:54

Public product avatar Query

query task