Virtual Try-On
try_on_productInitiate a virtual try-on for one or more products. Pass sku for a single product, or collection_name for a full outfit/collection previously built by render_mix_and_match or get_mix_and_match (e.g. 'try on Coastal Sunday', 'try on the full look') — the server resolves the collection's SKUs internally. Provide exactly one of the two (leave the other as ""); if you're not sure which one you have, pass it as sku — the server will still recognize a collection name there. Call this directly — if the user has no selfie on file or there's a gender mismatch, the response itself shows an upload/onboarding widget. Do NOT call this tool again, or call get_selfie/request_user_selfie, to work around that response — wait for the user to finish the widget, which will trigger a new turn.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sku | Yes | The product SKU to try on. Required field — pass an empty string "" if not applicable. Leave empty when using collection_name instead. | |
| country | Yes | ISO country code, e.g. 'IN', 'US'. | |
| collection_name | Yes | The exact label of a previously built outfit/collection (from render_mix_and_match or get_mix_and_match), for trying on multiple products together. Required field — pass an empty string "" if not applicable. Leave empty when using sku instead. |