API reference · FASHN

fashn/tryon/v1.5

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

IMAGEAsyncOpen model
Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run
Model IDfashn/tryon/v1.5
01

Input Schema

9 parameters · 0 required · 9 optional

ParameterTypeRequiredDescription
seedintegerOptionalSets random operations to a fixed state. Use the same seed to reproduce results with the same inputs, or different seed to force different results.
categorystringOptionalCategory of the garment to try-on. 'auto' will attempt to automatically detect the category of the garment. · Options: tops, bottoms, one-pieces, auto · Default: "auto"
topsbottomsone-piecesauto
model_imagestringOptionalURL or base64 of the model image
num_samplesintegerOptionalNumber of images to generate in a single run. Image generation has a random element in it, so trying multiple images at once increases the chances of getting a good result. · Min: 1 · Max: 4 · Default: 1
garment_imagestringOptionalURL or base64 of the garment image
output_formatstringOptionalOutput format of the generated images. 'png' is highest quality, while 'jpeg' is faster · Options: png, jpeg · Default: "png"
pngjpeg
moderation_levelstringOptionalContent moderation level for garment images. 'none' disables moderation, 'permissive' blocks only explicit content, 'conservative' also blocks underwear and swimwear. · Options: none, permissive, conservative · Default: "permissive"
nonepermissiveconservative
segmentation_freebooleanOptionalDisables human parsing on the model image. · Default: true
garment_photo_typestringOptionalSpecifies the type of garment photo to optimize internal parameters for better performance. 'model' is for photos of garments on a model, 'flat-lay' is for flat-lay or ghost mannequin images, and 'auto' attempts to automatically detect the photo type. · Options: auto, model, flat-lay · Default: "auto"
automodelflat-lay
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

  1. Submit — POST to /v1/run, receive an id
  2. Poll — GET /v1/run/{id} until status is completed, failed, or timeout
  3. Retrieve — Read outputs from the completed response
03

Code Examples

Ready-to-run snippets

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "fashn/tryon/v1.5",
  "category": "auto",
  "model_image": "https://static.sandbase.ai/examples/fashn/tryon/v1.5/input_model_image_1.bin",
  "num_samples": 1,
  "garment_image": "https://static.sandbase.ai/examples/fashn/tryon/v1.5/input_garment_image_0.bin",
  "output_format": "png",
  "moderation_level": "permissive",
  "segmentation_free": true,
  "garment_photo_type": "auto",
  "prompt": "a beautiful sunset over mountains"
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"