Skip to main contentModel Image
image URL | base64
model_image is the primary image of the person on whom the virtual try-on or the photoshoot will be performed. You can provide the image as a publicly accessible URL or a base64 string.
Model image guide
Parameter Details
- Type:
string (URL or base64 data URI)
- Required: Yes
- Description: URL or base64 data URI of the model/person image
- Supported formats: PNG, JPG, JPEG
- Recommended size: Less than 10MB
- Resolution: 768 x 1024 pixels (Width x Height) recommended. Min: 512x512, Max: 4096x4096
- Aspect ratio: 3:4 portrait orientation recommended for best results
- Processing: Input images are automatically scaled to 768x1024. Non-3:4 aspect ratios will be cropped to maintain proper proportions
Model Image Requirements
Garment Image
image URL | base64
garment_image is the clothing item that will be virtually tried on the model. You can provide the image as a publicly accessible URL or a base64 string.
Garment image guide
Parameter Details
- Type:
string (URL or base64 data URI)
- Required: Yes
- Description: URL or base64 data URI of the garment image
- Supported formats: PNG, JPG, JPEG
- Recommended size: Less than 10MB
- Resolution: 768 x 1024 pixels (Width x Height) recommended. Min: 512x512, Max: 4096x4096
- Aspect ratio: 3:4 portrait orientation recommended for best results
- Processing: Input images are automatically scaled to 768x1024. Non-3:4 aspect ratios will be cropped to maintain proper proportions
Garment Image Requirements
Category
Parameter Details
- Type:
string
- Required: No
- Default:
auto
- Description: Specifies the type of garment for virtual try-on
- Allowed values:
auto - Automatically detects the garment category (default)top - Upper body garments (shirts, t-shirts, blouses, jackets, etc.)bottom - Lower body garments (pants, skirts, shorts, etc.)one-piece - Full body garments (dresses, jumpsuits, rompers, etc.)top-and-bottom - Full outfit (upper body and lower body garments)
