# WEARFITS Virtual Try-On API — Frequently Asked Questions

Base URL: https://api.wearfits.com

Last updated: 2026-11-06.

## What is WEARFITS?

WEARFITS is an AI virtual try-on and 3D product generation API for fashion ecommerce. Developers integrate it into storefronts and apps; it is not a consumer app.

## How do I add virtual try-on to my online store?

For storefronts, the recommended path is the hosted iframe at https://tryon.wearfits.com/?sizeFitting=true. Follow https://tryon.wearfits.com/docs/integration.html for READY/INIT and base product handoff. Put the optional sizeChart sibling field on each WEARFITS_INIT.payload.products[] item; SET_PRODUCTS uses the same product shape. The chart requires version 1, basis "body", unit "cm" or "in", and body ranges for height, chest, waist, hip, or inseam. The storefront does not expose a service API key. Demo: https://tryon.wearfits.com/demo_tryon.html. For a custom backend and UI, use the direct API. https://api.wearfits.com/widget/tryon.js remains a lightweight API-backed modal without the hosted size-fitting overlay; mint a storefront token server-side and pass it as data-storefront-token, and never put a dashboard-issued merchant key in the page.

## What is the difference between virtual-fitting and shoe-3d?

POST /api/v1/virtual-fitting creates or reuses a digital twin and returns a try-on image from garment slots or productImage. POST /api/v1/shoe-3d turns shoe or bag photos into a 3D GLB model, with optional WEARFITS AR upload. A live AR viewer is distinct from image-based try-on.

## Which endpoint should I use for clothing vs shoes vs bags?

Twin-backed image try-on → POST /api/v1/virtual-fitting. Raw-photo clothing or shoe try-on without creating a twin → POST /api/v1/tryon/clothing or /api/v1/tryon/shoes. 3D shoe assets with optional AR upload → POST /api/v1/shoe-3d. Handbag assets → POST /api/v1/shoe-3d with options.productType set to "other" or "auto". Many products at once → POST /api/v1/digitization/batches.

## Does WEARFITS require a full-body photo of the customer?

No. POST /api/v1/digital-twin requires faceImage plus exactly one body source: clothingSize, bodyMeasurements, silhouetteImage, or bodyPhotoUrl. A full-body photo is only one choice. Height and weight may accompany bodyPhotoUrl and refine the generated body, but only when gender is male or female and the pose is not preserved. Inline virtual-fitting photo mode needs faceImage plus photoUrl; photoUrl alone is accepted by validation but cannot generate a new twin.

## Is the API synchronous or asynchronous?

Generation is asynchronous; a cache hit may already be completed. Poll the returned jobId at GET /api/v1/jobs/{jobId} with the same authentication ownership until completed or failed, or supply webhookUrl for a signed callback. Batch requests return batchId and have their own status endpoint. Estimated size fitting is synchronous and non-billable.

## How do I authenticate?

Protected operations use X-API-Key. Check each operation and its overrides at https://api.wearfits.com/doc. Merchant and service keys stay server-side. Merchant/bare service jobs belong to the submitting key; account-attributed service jobs and storefront jobs use separate account-scoped ownership. A storefront token (wfs1.) only allows virtual-fitting submission and job polling, not size-fitting or 3D generation. Renew tokens server-side and retain the same ownership and authentication mode. An unrelated owner gets 404. See https://api.wearfits.com/llms-full.txt for details.

## Does WEARFITS support Shopify and WooCommerce?

Yes. For either storefront, the recommended complete UI and size-fitting path is the hosted iframe. Follow https://tryon.wearfits.com/docs/integration.html for READY/INIT and base product handoff. Put the optional sizeChart sibling field on each WEARFITS_INIT.payload.products[] item; SET_PRODUCTS uses the same product shape. The chart requires version 1, basis "body", unit "cm" or "in", and body ranges for height, chest, waist, hip, or inseam. Test it at https://tryon.wearfits.com/demo_tryon.html. The widget remains a lightweight API-backed alternative without the hosted size-fitting overlay. Platform pages: https://wearfits.com/lp2/shopify-shoes/ and https://wearfits.com/lp2/woocommerce-shoes/.

## Which endpoint should I use for virtual try-on?

POST /api/v1/virtual-fitting always creates or reuses a digital twin. POST /api/v1/tryon/clothing uses a person photo, or the image of an existing digitalTwinId, without generating a new twin. Both support productImage for a direct two-image try-on.

## Which digital twin inputs are supported, and how long are twins cached?

For POST /api/v1/digital-twin, supply faceImage plus exactly one body input: bodyPhotoUrl, silhouetteImage, clothingSize, or bodyMeasurements. Height and weight may accompany bodyPhotoUrl and refine the generated body, but only when gender is male or female and the pose is not preserved. Inline POST /api/v1/virtual-fitting photo mode requires faceImage plus photoUrl for new generation. Digital twins are cached for 30 days; save the completed job’s digitalTwinId to reuse the avatar.

## Does virtual try-on provide an exact size recommendation?

No. A try-on image is a visual preview. POST /api/v1/size-fitting separately returns estimated size guidance using an eligible measurements/clothing-size twin and merchant body-range charts. Photo/direct twins return available: false. This synchronous operation is non-billable.

## How do I receive generated results?

Generation runs asynchronously; cache hits may already be completed. Poll GET /api/v1/jobs/{jobId} with the same authentication ownership. Merchant and bare service keys must use the submitting key and support private-key-derived HMAC webhook verification. Prefer authenticated polling for account-attributed and storefront requests; see /llms-full.txt for callback limitations and verification.

## Can I generate 3D shoes and bags for AR?

POST /api/v1/shoe-3d generates GLB assets from product photos, with optional texture enhancement and WEARFITS AR upload. For bags, set options.productType to "other" or "auto". POST /api/v1/digitization/batches accepts up to 500 products and 10 images per product. Live AR is a separate viewer experience, not the photo try-on endpoint.

## Should I use the hosted iframe, REST API, or widget?

For storefronts, use the hosted iframe for the complete try-on and size-fitting UI. Use the REST API from your backend when building your own UI. The lightweight /widget/tryon.js modal does not include the hosted size-fitting overlay. Keep merchant and service API keys server-side; use a storefront token or backend proxy for browser integrations.

## Where is the machine-readable API specification?

The OpenAPI 3.1 specification is available at https://api.wearfits.com/doc, with an interactive reference at /reference. AI agents can start at /llms.txt, read /llms-full.txt, and use the Markdown guides under /docs/.

## Can the same customer avatar be reused?

Yes. Save the returned digitalTwinId and pass it in later requests to skip twin generation.

## Which product categories are supported?

Tops, bottoms, and full-body garments such as dresses or jumpsuits. Garment-slot requests require clothing and can add shoes to the outfit. Alternatively, productImage supports a single product, including a shoe. For 3D assets with optional WEARFITS AR upload, use the separate shoe-3d endpoint.

## Does the API return synchronously?

Virtual fitting creates an asynchronous job. Poll GET /api/v1/jobs/{jobId} or use signed webhooks.

## How long are digital twins cached?

Digital twins are cached for 30 days by default.

## Can users avoid full-body photos?

Yes. Pair faceImage with clothingSize or bodyMeasurements instead of a full-body photo. A face photo is still required. Size recommendations additionally require a supported stored body profile of sufficient quality.

## How is a saved twin checked?

Call GET /api/v1/digital-twin/{id} to verify that a saved digitalTwinId is still valid.

## Can bags be processed too?

Yes. Set options.productType to "other" or "auto" to route non-shoe products such as handbags away from shoe-specific processing.

## Can existing GLB files be enhanced?

Yes. Pass glbInput to skip generation. Very dense models may be simplified before processing (best effort; not an enforced limit). Texture enhancement and WEARFITS upload depend on options. Supply reference images when enhancing textures.

## Is batch digitization supported?

Yes. POST /api/v1/digitization/batches queues up to 500 products per batch, processed at lower priority than real-time traffic.

## Where is the full API specification?

The OpenAPI 3.1 specification is at https://api.wearfits.com/doc and the Swagger UI at https://api.wearfits.com/reference.
