1. v1
Topview-api-English version
  • API Document
  • Release Note
  • Image Translate
    • ImageTranslate
  • Photo Avatar/Avatar 4
    • Avatar4
  • Avatar Marketing Video
    • script
      • List script content
      • Update script content
    • Submit task
      POST
    • Query task
      GET
    • Export
      POST
  • Video Avatar
    • Video Avatar API Usage
    • submit task
      POST
    • query task
      GET
  • Scraper
    • submit scraper task
      POST
    • query scraper task
      GET
  • Upload
    • Get Upload Credential
      GET
    • Upload File
      PUT
    • Get Upload Check
      GET
  • Product Avatar
    • v2
      • Product Avatar V2 API Usage
      • Replace Product Image
        • location parameters document
        • submit task
        • query task
      • Image2Video
        • submit task
        • query task
      • Category Query
      • Public product avatar Query
    • v1
      • Product Avatar API Usage
      • Replace Product Image
        • submit task
        • query task
        • download result without watermark
      • Image2Video
        • submit task
        • query task
      • Category Query
        GET
      • Public product avatar Query
        GET
  • Common Task
    • image2Video
      • submit task
      • query task
    • video2aiavatar
      • submit task
      • query task
    • Image Remove Background
      • submit task
      • query task
  • Product AnyShoot
    • v1
      • Replace Product Image
        • submit task
        • query task
      • Template Category
      • Template List
    • v2
      • Product AnyShoot - V2 - Product Model
      • Product AnyShoot - V2 - Product Background
  • Voice
    • Voice Clone
      • submit task
      • query task
    • text2voice
      • submit task
      • query task
  • Caption List
    GET
  • Voice Query
    GET
  • AiAvatar Query
    GET
  • check notice url
    POST
  • Delete Custom Avatar
    DELETE
  • Delete Custom Voice
    DELETE
  • Ethnicity Query
    GET
  1. v1

Product Avatar API Usage

Main process#

Replace Product Image Task#

1.
Call interface Product Avatar - Image2Vdieo - submit task. Submit the task of Replace Product Image.
avatarIdfield. Please call interface Public product avatar Query；
productImageFileId、templateImageFileId、userFaceImageFileIdfields all require obtaining S3 file credentials first, and then uploading local files to S3 through the credentials. Focus onfileId、uploadUrl。Please refer to the document for API Document - upload；
noticeUrlfield，Please refer to the document for API Document - Notice Url。
2.
Call interface Product Avatar - Image2Vdieo - query task. Obtain the result of the 'Replace Product Image' task.

Image2Video Task#

1.
Call interface Product Avatar - Image2Vdieo - submit task. Submit the task of Image2Video.
productReplaceResultKey field must be the productReplaceResult-key value in the return result of interface Product Avatar - Image2Vdieo - query task ；
voiceoverIdfield，Please call interface Voice Query；
noticeUrlfield. Please refer to the document for API Document - Notice Url。
2.
Call interface Product Avatar - Image2Vdieo - query task. Obtain the result of the 'Image2Video' task.
Modified at 2025-08-11 12:50:07
Previous
Public product avatar Query
Next
submit task
Built with