Virtual Try-On

Complete the outfit

Suggest complementary pieces for a base product to form a styled outfit.

post/v1/complete-outfit

Request

  • Base URL: https://api.crayonz.ai
  • URL: https://api.crayonz.ai/v1/complete-outfit
  • Auth: API key in header X-API-Key

Request body

productImagesstring[] required

1–10 product image URLs to pair into outfits

userImagestring

Optional shopper photo or try-on result, so pairings suit their look

Example request

{
  "productImages": [
    "https://example.com/tee.png",
    "https://example.com/jeans.png",
    "https://example.com/jacket.png"
  ]
}

Response

Success

outfitsobject[]

One entry per suggested pairing: itemIndices (into productImages), description, category

summarystring

Changes

No recorded changes to this operation across all 1 revision of this API.