submit task

POST

/v2/product_avatar/task/image_replace/submit

Interface Function: Generate an image of a person holding a product using (avatarId or templateImageFileId) + productImageWithoutBackgroundFileId.

Points Consumption: No points are deducted for failed tasks; 1 point/task is deducted for successful tasks.

Explanation of location Parameter: location parameter documentation.

Request

Header Params

Body Params application/json

Example

{
    "generateImageMode": "string",
    "avatarId": "string",
    "templateImageFileId": "string",
    "productImageWithoutBackgroundFileId": "string",
    "userFaceImageFileId": "string",
    "imageEditPrompt": "string",
    "location": [
        [
            0
        ]
    ],
    "noticeUrl": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.topview.ai/v2/product_avatar/task/image_replace/submit' \
--header 'Topview-Uid;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "generateImageMode": "string",
    "avatarId": "string",
    "templateImageFileId": "string",
    "productImageWithoutBackgroundFileId": "string",
    "userFaceImageFileId": "string",
    "imageEditPrompt": "string",
    "location": [
        [
            0
        ]
    ],
    "noticeUrl": "string"
}'

Responses

🟢200OK

application/json

Body

Example

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

Modified at 2025-08-12 02:13:26

location parameters document

query task