Multimodal AI

AI Suit Virtual Try-On API

Dress a model image with a one-piece outfit or suit image, supporting optional garment and model masks.

post/api/skill-api/v1/skills/ai-suit-virtual-try-on/run

Request

  • Base URL: https://api.nexscope.ai
  • URL: https://api.nexscope.ai/api/skill-api/v1/skills/ai-suit-virtual-try-on/run
  • Auth: HTTP bearer

Headers

X-Nexscope-Http-Status'legacy' | 'semantic'

Use semantic for HTTP error statuses on run and task-result requests. Without this header v1 retains legacy status behavior. The JSON envelope is unchanged; code 0 means success or acceptance, not asynchronous completion.

Request body

suitOriginUrlstring required

Public URL of the original one-piece garment image. The image must be up to 20 MB and between 385 and 4096 pixels in both width and height.

modelImageUrlstring required

Public URL of the model image.

suitImageUrlstring

Optional processed suit mask or crop URL.

modelMaskImageUrlstring

Optional mask URL for the model body area.

outputNuminteger

Number of images to generate, from 1 to 4. Defaults to 1.

Example request

{
  "suitOriginUrl": "https://example.com/suit.jpg",
  "modelImageUrl": "https://example.com/model-reference.jpg",
  "suitImageUrl": "https://example.com/suit-mask.png",
  "modelMaskImageUrl": "https://example.com/mask.png",
  "outputNum": 1
}

Response

Successful response.

codeinteger required

0 means accepted or successful; nonzero is a platform error.

msgstring nullable required
tsstring required

Epoch milliseconds.

timestring required

Server local time: yyyy-MM-dd HH:mm:ss.

coststring required

Elapsed milliseconds, never credits; -1 outside web requests.

traceIdstring nullable required

Changes

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