Topview-api-English version
  1. Replace Product Image
Topview-api-English version
  • API Document
  • Avatar Marketing Video
    • script
      • List script content
      • Update script content
    • Submit task
      POST
    • Query task
      GET
    • Export
      POST
  • Video Avatar
    • submit task
      POST
    • query task
      GET
  • Scraper
    • submit scraper task
      POST
    • query scraper task
      GET
  • Upload
    • Get Upload Credential
      GET
    • Get Upload Check
      GET
  • Product Avatar
    • Replace Product Image
      • submit task
        POST
      • query task
        GET
    • Image2Video
      • submit task
      • query task
    • Category Query
      GET
    • Public product avatar Query
      GET
  • Common Task
    • image2Video
      • submit task
      • query task
  • Product AnyShoot
    • Replace Product Image
      • submit task
      • query task
    • Template Category
      GET
    • Template List
      GET
  • Caption List
    GET
  • Voice Query
    GET
  • AiAvatar Query
    GET
  • check notice url
    POST
  • Ethnicity Query
    GET
  1. Replace Product Image

submit task

Developing
POST
/v1/product_avatar/task/image_replace/submit

Request

Header Params
Authorization
string 
required
Topview-Uid
string 
required
Body Params application/json
avatarId
string 
optional
AvatarId and templateImageFileId must have one non empty value
productImageFileId
string 
required
cannot be empty
templateImageFileId
string 
optional
AvatarId and templateImageFileId must have one non empty value
userFaceImageFileId
string 
optional
imageEditPrompt
string 
required
Example:
Replace the item in the hand of the person in Picture 1 with the one in Picture 2. Keep the composition position and gesture of the person in Picture 1 unchanged, and ensure that the features, appearance and details of the item in Picture 2 remain exactly the same after the change.
productSize
enum<string> 
optional
Allowed values:
123456
Default:
2
noticeUrl
string 
optional
Please refer to the API documentation for details
Example
{
    "avatarId": "string",
    "productImageFileId": "string",
    "templateImageFileId": "string",
    "userFaceImageFileId": "string",
    "imageEditPrompt": "Replace the item in the hand of the person in Picture 1 with the one in Picture 2. Keep the composition position and gesture of the person in Picture 1 unchanged, and ensure that the features, appearance and details of the item in Picture 2 remain exactly the same after the change.",
    "productSize": "2",
    "noticeUrl": "string"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.topview.ai/v1/product_avatar/task/image_replace/submit' \
--header 'Authorization;' \
--header 'Topview-Uid;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "avatarId": "string",
    "productImageFileId": "string",
    "templateImageFileId": "string",
    "userFaceImageFileId": "string",
    "imageEditPrompt": "Replace the item in the hand of the person in Picture 1 with the one in Picture 2. Keep the composition position and gesture of the person in Picture 1 unchanged, and ensure that the features, appearance and details of the item in Picture 2 remain exactly the same after the change.",
    "productSize": "2",
    "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-05-28 02:53:31
Previous
Get Upload Check
Next
query task
Built with