FASHN Virtual Try-On V1.6

POST/v1/run

Tryon V1.6 by FASHN - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to fashn/tryon/v1.6.

Default: fashn/tryon/v1.6

Optional<string>output_format

Output format of the generated images. 'png' is highest quality, while 'jpeg' is faster

Allowed values: png, jpeg

Default: png

Optional<integer>seed

Sets random operations to a fixed state. Use the same seed to reproduce results with the same inputs, or different seed to force different results.

Optional<string>model_image

URL or base64 of the model image

Optional<string>garment_photo_type

Specifies 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.

Allowed values: auto, model, flat-lay

Default: auto

Optional<boolean>segmentation_free

Disables human parsing on the model image.

Default: true

Optional<string>garment_image

URL or base64 of the garment image

Optional<string>category

Category of the garment to try-on. 'auto' will attempt to automatically detect the category of the garment.

Allowed values: tops, bottoms, one-pieces, auto

Default: auto

Optional<string>moderation_level

Content moderation level for garment images. 'none' disables moderation, 'permissive' blocks only explicit content, 'conservative' also blocks underwear and swimwear.

Allowed values: none, permissive, conservative

Default: permissive

Optional<integer>num_samples

Number 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.

Range: 1 to 4

Default: 1

Response Schema

The submit endpoint returns an accepted generation task. Poll the result endpoint with the returned id for terminal outputs or errors.

Optional<string>error

Error message if the task failed. Empty on success.

stringidrequired

Unique identifier for the generation task.

Optional<string>model

Model ID used for the prediction.

Optional<array>outputs

Array of generated content. Empty when status is not completed.

stringstatusrequired

Status of the task: pending, running, completed, failed, or timeout.

Allowed values: pending, running, completed, failed, timeout

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: image-to-image

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async

# 1. Submit a generation request
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "fashn/tryon/v1.6",
  "output_format": "png"
}'

# 2. If the response is still running, poll the returned id
curl https://api.sandbase.ai/v1/run/run_abc123 \
  -H "Authorization: Bearer $SANDBASE_API_KEY"

Response202 Accepted

{
  "id": "run_abc123",
  "model": "fashn/tryon/v1.6",
  "status": "running",
  "outputs": []
}