For the complete documentation index, see llms.txt. This page is also available as Markdown.

Virtual Try-On

Overview

Virtual Try-On lets you automatically place a piece of clothing on an a person:

(original image)

(edited image)

+

+

+

Virtual Try-On is meant to be used with images that feature clothing items.

Main Parameters

Virtual Try-On shares the same parameters than Virtual Model, but used in a different way.

To use Virtual Try-On, you'll need to use the following parameters:

virtualModel.mode

To enable Virtual Try-On, set the parameter virtualModel.mode to ai.auto.

virtualModel.model

The parameter virtualModel.model lets you control the likeness of the person wearing the clothing.

The image of that person is provided using either the parameter virtualModel.model.custom.imageFile or virtualModel.model.custom.imageUrl.

The parameter virtualModel.model.custom.imageFile is only available when using the POST endpoint.

virtualModel.scene

The parameter virtualModel.scene lets you control the environment in which the person will be placed.

You can either use a pre-set scene or a custom one.

To use a pre-set scene, set the parameter virtualModel.scene.preset.name to the name of the pre-set scene that you want to use.

List of pre-set scenes
Cover

random

Cover

street

Cover

bedroom

Cover

sunset

Cover

factory

Cover

studio

Cover

coloredstudio

Cover

concretestudio

Cover

beach

Cover

tropical

Cover

library

Cover

forest

Cover

businessdistrict

Cover

countryside

Cover

flowers

Cover

goldenlight

Cover

mountain

Cover

pool

Cover

latincity

Cover

cafe

Cover

asiancity

Cover

nightlights

Cover

desert

To use a custom scene, you will need to provide an image of that scene using either the parameter virtualModel.scene.custom.imageFile or virtualModel.scene.custom.imageUrl.

The parameter virtualModel.scene.custom.imageFile is only available when using the POST endpoint.

By default, this parameter will be set to virtualModel.scene.preset.name=random.

virtualModel.pose

The parameter virtualModel.pose lets you control the pose of the person.

You can pick between a list of pre-set poses:

List of pre-set poses
Cover

random

Cover

standing

Cover

34turn

Cover

powerstance

Cover

walkingforward

Cover

handinpocket

Cover

crossedarms

Cover

back

Cover

overtheshoulder

Cover

seated

Cover

adjustingclothing

Cover

playfulspin

For a Virtual Try-On, we recommend setting virtualModel.pose=standing

By default, this parameter will be set to virtualModel.pose=random.

Which resolutions are supported?

By default, Virtual Try-On will produce outputs at a resolution of 1K (1024x1024).

Output resolutions of 2K and 4K are available for Enterprise plans:

(original image)
(default 1K output)
(4K output)
(original image)
(default 1K output)
(4K output)
(original image)
(default 1K output)
(4K output)

Make sure to click on the images to see them in full resolution.

If you're interested to use 2K or 4K resolution, please contact our team to book a demo.

Book a demo

Additional Parameters

virtualModel.additionalProductImages[]

Additional product images showing different angles or details of the same item.

These help the model better understand the product and generate more accurate results.

To provide these images, use either the parameter virtualModel.additionalProductImages[].imageFile or virtualModel.additionalProductImages[].imageUrl.

The parameter virtualModel.additionalProductImages[].imageFile is only available when using the POST endpoint.

virtualModel.prompt

Optional text prompt to guide the generation style.

Example: street style

virtualModel.size

The output size and aspect ratio of the generated image.

Default: PORTRAIT_HD_3_2

Possible values: PORTRAIT_HD_16_9, PORTRAIT_HD_4_3, PORTRAIT_HD_3_2, SQUARE_HD, LANDSCAPE_HD_3_2, LANDSCAPE_HD_4_3, LANDSCAPE_HD_16_9

Last updated

Was this helpful?