
Product Image Replacement
API Overview
productAnyShoot ReplaceImage is an interface provided by the Topview platform that enables intelligent replacement of product images. It allows users to replace specified product images with template images and automatically generate new product display images.
Price:
productAnyShoot ReplaceImage:0.125 PTC/image
productAnyShoot ReplaceImage V3:0.125 PTC/image
Product ImageReplace V3:0.25 PTC/image
Remove Background:0.25 PTC/image
API Console
Log in to explore more features! Click to Log In
API Reference (11)
| API Description | API Endpoint | Request Method | Stability | Parameter Description |
|---|---|---|---|---|
productAnyShoot ReplaceImage Submit | POST | Stable | View Details | |
Document Details productAnyShoot ReplaceImage is an intelligent product image replacement API provided by the Topview platform. It allows users to replace a specified product image with a template image and automatically generate a new product display image. Request Parameters Header ParametersAuthorizationstringOptional Example Value: Bearer {{YOUR_API_KEY}}Request Body application/jsonproductImageFileIdstringRequired Product image file ID templateIdstringOptional Template Number templateMaskFileIdstringRequired Template mask fileId. [Must be consistent with the original image size] User generates it themselves modestringOptional Mode. easy/advanced generatingCountintegerRequired Generating Count. Supports 1 to 4 easyModePromptstringRequired You are a professional software documentation translation expert.
productMaskFileIdstringOptional Product mask fileId. [Must be consistent with the original image size] If uploaded, the user needs to generate it themselves. templateImageFileIdstringOptional Template image fileId. TemplateId and template image fileId cannot both be empty. If both templateId and template image fileId exist, templateImageFileId will take precedence over TemplateId. | ||||
productAnyShoot ReplaceImage Query | GET | Stable | View Details | |
Document Details Price: 0 PTC/time Request Parameters Header ParametersAuthorizationstringOptional Example Value: Bearer {{YOUR_API_KEY}}Query ParameterstaskIdstringOptional Example Value: 08e1dcb048374d72bcffec180fe42c13 | ||||
productAnyShoot ReplaceImage V3 Submit | POST | Stable | View Details | |
Document Details Use product images, product mask images, model images, and model mask images to create composite result images. Request Parameters Header ParametersAuthorizationstringOptional Example Value: Bearer {{YOUR_API_KEY}}Request Body application/jsonproductImageFileIdstringRequired Upload local image file productMaskFileIdstringOptional Must be generated by the user. [Must match the dimensions of productImageFileId] templateIdstringOptional Obtain the parameter value from the template list interface. templateId and templateImageFileId cannot be empty at the same time; if both templateId and templateImageFileId exist, templateImageFileId will take precedence. templateImageFileIdstringOptional Default value: 95b1f133c91e40f281a3de22c5bd1637 templateMaskFileIdstringRequired Default value: 8144698c4007473fbc1137143cac2437 generatingCountenum<string>Required Allowed values: Enum Value: 1234 | ||||
productAnyShoot ReplaceImage V3 Query | GET | Stable | View Details | |
Document Details Price: 0 PTC/time Request Parameters Header ParametersAuthorizationstringOptional Example Value: Bearer {{YOUR_API_KEY}}Query ParameterstaskIdstringOptional Example Value: 08e1dcb048374d72bcffec180fe42c13 | ||||
Product ImageReplace V3 Summit | POST | Stable | View Details | |
Document Details Product ImageReplace is an interface for intelligent replacement of product digital human image commodity pictures provided by the Topview platform. It supports users to replace specified commodity pictures with template pictures and automatically generate new product digital human images. It is widely used in scenarios such as e-commerce display and marketing content. Request Parameters Header ParametersAuthorizationstringOptional Example Value: Bearer {{YOUR_API_KEY}}Request Body application/jsonavatarIdstringOptional Either AvatarId or templateImageFileId must have a non-null value imageEditPromptstringRequired Prompt word templateImageFileIdstringRequired Either AvatarId or templateImageFileId must have a non-null value userFaceImageFileIdstringOptional productImageWithoutBackgroundFileIdstringRequired Defaults to 722e4c0ebdc148e295df9fe30c3160bd. 1. You can use the General Task - Remove Background interface to convert the product image into a product image without background; 2. Upload the product image without background. generateImageModeenum<string>Required Defaults to auto. Allowed values: Enum Value: automanual | ||||
Product ImageReplace V3 Query | GET | Stable | View Details | |
Document Details Price: 0 PTC/time Request Parameters Header ParametersAuthorizationstringOptional Example Value: Bearer {{YOUR_API_KEY}}Query ParameterstaskIdstringOptional Example Value: 64c41ba04e584c80bcd6f1a87939955c | ||||
Remove Background Summit | POST | Stable | View Details | |
Document Details Remove Background is a feature provided by the Topview platform to generate product images without a background. Request Parameters Header ParametersAuthorizationstringOptional Example Value: Bearer {{YOUR_API_KEY}}Request Body application/jsonproductImageFileIdstringRequired | ||||
Remove Background Query | GET | Stable | View Details | |
Document Details Price: 0 PTC/Time Request Parameters Header ParametersAuthorizationstringOptional Example Value: Bearer {{YOUR_API_KEY}}Query ParameterstaskIdstringOptional Example Value: 64c41ba04e584c80bcd6f1a87939955c | ||||
Query Template List | GET | Stable | View Details | |
Document Details Used to obtain a list of all available product smart shooting templates Request Parameters Header ParametersAuthorizationstringOptional Example Value: Bearer {{YOUR_API_KEY}}Query ParameterscategoryIdsstringOptional stylestringOptional pageNostringOptional pageSizestringOptional | ||||
Query Template Categories | GET | Stable | View Details | |
Document Details Used to obtain category information for all product shooting templates Request Parameters Header ParametersAuthorizationstringOptional Example Value: Bearer {{YOUR_API_KEY}} | ||||
Upload Interface | POST | Stable | View Details | |
Document Details Currently, only mp4, mov, png, jpg, jpeg, bmp, webp, mp3, wav, and m4a are supported. Request Parameters Header ParametersAuthorizationstringOptional Example Value: Bearer {{YOUR_API_KEY}}Request Body application/jsonfilestringRequired | ||||
API Pricing
| Model | Description | 302.AI Price |
|---|
productAnyShoot ReplaceImage Submit | Product Image Replacement |
|
productAnyShoot ReplaceImage Query | Product Image Replacement |
|
productAnyShoot ReplaceImage V3 Submit | Product Image Replacement |
|
productAnyShoot ReplaceImage V3 Query | Product Image Replacement |
|
Product ImageReplace V3 Summit | Product Image Replacement |
|
Product ImageReplace V3 Query | Product Image Replacement |
|
Remove Background Summit | Remove Background |
|
Remove Background Query | Remove Background |
|
Query Template List | Product Image Replacement |
|
Query Template Categories | Product Image Replacement |
|
Upload Interface | Upload Interface |
|