Skip to main content

Try On (Beta)

POST 
/v1/try-on

BETA - This endpoint is currently in beta and may change without notice.

Places a garment onto a person image.

For Best Results:

  • Person Image:
    • There should only be one person in the image.
    • Plain backgrounds and no accessories are best
    • The person should take up most of the frame, a 3/4 body view works best.
    • The person should be standing facing forward, side/seated views work less well.
  • Garment Image:
    • The garment image should only contain a single garment.
    • Plain "stock photos" of garments work best, however the model is capable of transferring garments from one person to another.
    • The garment should take up most of the frame.

Limitations:

  • The API may not work with all garments, it works best with top garments like t-shirts, blouses, etc.
  • Text and fine details in the garment image may not be reproduced perfectly in the resulting image.
  • Colors in the resulting image may be slightly different to the colors in the garment image.

Input Image Limits:

  • Max size: 25MB
  • Min resolution: 256x256px
  • Max resolution: 1920x1920px

Request​

Header Parameters

    Accept string

    Acceptable response media type(s). application/json.

Body

    person_image_url url

    URL of the image. Background will be automatically removed.

    garment_image_url url

    URL of the image. Background will be automatically removed.

    garment_mode GarmentModeParameter (string)

    Possible values: [auto, full, upper, lower]

    Default value: auto

    Indicates the garment type for the try-on service. Determines how the garment is applied on the person image.
    - auto: Automatically detects if the garment is full-body, upper-body, or lower-body.
    - full: Garment covers the full body (e.g., dresses, jumpsuits).
    - upper: Garment covers the upper body (e.g., shirts, jackets).
    - lower: Garment covers the lower body (e.g., pants, skirts).

    preprocess_garment PreprocessGarmentParameter (string)

    Possible values: [true, false]

    Default value: true

    When true, the garment will be preprocessed to remove background. Defaults to true. In some cases results of model will be improved by skipping pre-processing.

    remove_background RemoveBackgroundParameter (string)

    Possible values: [true, false]

    Default value: false

    When true, the background will be removed from the final result. Defaults to false.

    wait_for_result WaitForResultParameter (string)

    Possible values: [true, false]

    Default value: true

    When true, the API will wait for processing to complete and return the result directly. When false, it returns a job ID for polling.

Responses​

Success - returned when wait_for_result is true and processing completes successfully.

Schema

    result_url string

    A URL to access the resultant image which is valid for 1 hour. File format will be jpeg.

Loading...