Pixazo API→Models→Fashn Virtual Try On

Fashn Virtual Try On API: Pricing, Documentation

Fashn Virtual Try On API, e-commerce platforms and fashion retailers can enable customers to visualize how garments will look on them before purchasing. The API handles complex fabric physics, body positioning, and lighting to create convincing virtual fitting experiences that reduce returns and increase conversion.

Get API Key

Models Version

WELCOME BONUS

Get $5 Free Credit on First Payment

No strings attached — add funds and get $5 bonus instantly

Claim Your $5 →

Fashn v1.6 API Documentation

https://gateway.pixazo.ai/fashn-virtual-try-on/v1/fashn-virtual-try-on-request

Authentication

All requests require an API key passed via header.

Header	Type	Required	Description
Ocp-Apim-Subscription-Key	string	Yes	Your API subscription key

Fashn Virtual Try-On generate request - Fashn Virtual Try-On API

Request Code

POST https://gateway.pixazo.ai/fashn-virtual-try-on/v1/fashn-virtual-try-on-request
Content-Type: application/json
Cache-Control: no-cache
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY

{
  "model_image": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/vt_human.jpg",
  "garment_image": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/vt_top.jpeg",
  "category": "auto",
  "mode": "balanced",
  "garment_photo_type": "auto",
  "moderation_level": "permissive",
  "num_samples": 1,
  "segmentation_free": true,
  "output_format": "png"
}

import requests

url = "https://gateway.pixazo.ai/fashn-virtual-try-on/v1/fashn-virtual-try-on-request"
headers = {
    "Content-Type": "application/json",
    "Cache-Control": "no-cache",
    "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}
data = {
    "model_image": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/vt_human.jpg",
    "garment_image": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/vt_top.jpeg",
    "category": "auto",
    "mode": "balanced",
    "garment_photo_type": "auto",
    "moderation_level": "permissive",
    "num_samples": 1,
    "segmentation_free": true,
    "output_format": "png"
}

response = requests.post(url, json=data, headers=headers)
print(response.json())

const url = 'https://gateway.pixazo.ai/fashn-virtual-try-on/v1/fashn-virtual-try-on-request';

const headers = {
  'Content-Type': 'application/json',
  'Cache-Control': 'no-cache',
  'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
};

const body = {
  model_image: 'https://pub-582b7213209642b9b995c96c95a30381.r2.dev/vt_human.jpg',
  garment_image: 'https://pub-582b7213209642b9b995c96c95a30381.r2.dev/vt_top.jpeg',
  category: 'auto',
  mode: 'balanced',
  garment_photo_type: 'auto',
  moderation_level: 'permissive',
  num_samples: 1,
  segmentation_free: true,
  output_format: 'png'
};

fetch(url, {
  method: 'POST',
  headers: headers,
  body: JSON.stringify(body)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

curl -X POST "https://gateway.pixazo.ai/fashn-virtual-try-on/v1/fashn-virtual-try-on-request" \
  -H "Content-Type: application/json" \
  -H "Cache-Control: no-cache" \
  -H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
  --data-raw '{
    "model_image": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/vt_human.jpg",
    "garment_image": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/vt_top.jpeg",
    "category": "auto",
    "mode": "balanced",
    "garment_photo_type": "auto",
    "moderation_level": "permissive",
    "num_samples": 1,
    "segmentation_free": true,
    "output_format": "png"
  }'

Output

{
  "request_id": "fashn-virtual-try-on_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "QUEUED",
  "polling_url": "https://gateway.pixazo.ai/v2/requests/status/fashn-virtual-try-on_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Try Now

Webhook (Optional)

Add the X-Webhook-URL header to your submit request to receive a POST callback when the job completes — no polling required.

Using curl? These are HTTP request headers — pass each with -H, e.g. -H "X-Webhook-URL: https://your-server.com/webhook/callback". Do not paste them as bare lines, and end every line of a multi-line command with \.

Webhook Headers

Header	Required	Default	Description
`X-Webhook-URL`	Yes (to enable)	—	HTTPS endpoint on your server that will receive the `POST` callback. Must respond `2xx` within a few seconds (process async if needed).
`X-Webhook-Mode`	No	`terminal`	`terminal` — fires once at the final status (`COMPLETED`/`FAILED`/`ERROR`). `sync` — fires on every poll cycle plus the terminal event, and caps the queue’s polling delay at 15s for tighter progress updates.

Example: enable webhook

X-Webhook-URL: https://your-server.com/webhook/callback
X-Webhook-Mode: terminal

Callback Payload

Your endpoint receives a POST application/json with the same shape as the GET /v2/requests/status/{request_id} response. Example terminal callback (mode terminal):

{
  "request_id": "fashn-virtual-try-on_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "COMPLETED",
  "model_id": "fashn-virtual-try-on",
  "error": null,
  "output": {
    "media_url": [
      "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/v1/fashn-virtual-try-on_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/output.png"
    ],
    "media_type": "image/png"
  },
  "created_at": "2026-05-22T13:17:32.110Z",
  "updated_at": "2026-05-22 13:19:23",
  "completed_at": "2026-05-22 13:19:23"
}

Failure callback shape

{
  "request_id": "fashn-virtual-try-on_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "ERROR",
  "model_id": "fashn-virtual-try-on",
  "error": "Description of the error",
  "output": null,
  "created_at": "...",
  "updated_at": "...",
  "completed_at": "..."
}

Delivery semantics

terminal mode (default) — exactly one POST when the request reaches a terminal status. No callback during PROCESSING.
sync mode — POST on every status poll (with delay capped at ~15s) plus a final POST at terminal status. Use when you want progress updates.
Idempotency — use request_id as your idempotency key. Network retries can deliver the same callback more than once; your handler must tolerate duplicates.
Response — respond 200 OK within a few seconds. The queue does not block on slow handlers, but persistent failures may stop further deliveries.
HTTPS required — plain http:// URLs are rejected.

Request Parameters - Fashn Virtual Try-On generate request

Parameter	Required	Type	Default	Allowed values / range	Description
model_image	Yes	string	—	—	URL or base64 of the model image — the person on whom the virtual try-on is performed. Publicly accessible HTTP/HTTPS URLs are recommended.
garment_image	Yes	string	—	—	URL or base64 of the garment image — the clothing item to be tried on. Accepts on-model, flat-lay, or ghost-mannequin photos.
category	No	string	auto	auto, tops, bottoms, one-pieces	Garment category. Use auto to detect the garment type automatically, or set it explicitly for tops, bottoms, or one-piece garments.
mode	No	string	balanced	performance, balanced, quality	Processing mode balancing speed and quality: performance is the fastest, quality gives the best results, balanced sits in between.
garment_photo_type	No	string	auto	auto, model, flat-lay	Type of garment photo supplied: model (worn on a person) or flat-lay (laid flat / ghost mannequin). auto detects the type automatically.
moderation_level	No	string	permissive	none, permissive, conservative	Content moderation level for garment images. conservative enforces stricter modesty standards; permissive allows swimwear and underwear; none disables moderation.
seed	No	integer	42	0 – 4294967295	Sets random operations to a fixed state. Use the same seed to reproduce results with the same inputs, or a different seed to force different results.
num_samples	No	integer	1	1 – 4	Number of try-on images to generate in a single request.
segmentation_free	No	boolean	true	true, false	Enables direct garment fitting without clothing segmentation, allowing bulkier garment try-ons. Set to false if unwanted clothing remains visible in the output.
sync_mode	No	boolean	false	true, false	If true, the generated image is returned inline as a data URI instead of a hosted URL. Increases response size and latency.
output_format	No	string	png	png, jpeg	Format of the generated image. png offers lossless quality; jpeg produces smaller files.

Content Item Types & Limits

Type	Max	Format / Size	Description
model_image	1	JPG, PNG	Person / model photo (min 300×300).
garment_image	1	JPG, PNG	Garment image (min 300×300).

Example Request

{
  "model_image": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/vt_human.jpg",
  "garment_image": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/vt_top.jpeg",
  "category": "auto",
  "mode": "balanced",
  "garment_photo_type": "auto",
  "moderation_level": "permissive",
  "num_samples": 1,
  "segmentation_free": true,
  "output_format": "png"
}

Response

{
  "request_id": "fashn-virtual-try-on_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "QUEUED",
  "polling_url": "https://gateway.pixazo.ai/v2/requests/status/fashn-virtual-try-on_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Request Headers

Header	Value
Content-Type	application/json
Cache-Control	no-cache
Ocp-Apim-Subscription-Key	YOUR_SUBSCRIPTION_KEY

Response Handling

Common status codes.

Code	Meaning
202	Accepted — Request queued
400	Bad Request
401	Unauthorized
402	Insufficient Balance
403	Forbidden
429	Too Many Requests
500	Internal Server Error

Error Responses

Queue system errors and model validation errors.

Queue System Errors

// 402 — Insufficient balance
{
  "error": "Insufficient Balance",
  "message": "Your wallet does not have enough balance."
}

// 400 — Model not found
{
  "error": "Model not found",
  "message": "Model 'fashn-virtual-try-on' not found or is disabled"
}

Error via Status/Webhook

{
  "request_id": "fashn-virtual-try-on_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "ERROR",
  "model_id": "fashn-virtual-try-on",
  "error": "Description of the error",
  "output": null
}

Retrieving Results

Poll the universal status endpoint to check progress and retrieve results.

Endpoint

GET https://gateway.pixazo.ai/v2/requests/status/{request_id}
Ocp-Apim-Subscription-Key: YOUR_API_KEY

cURL Example

curl -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
  "https://gateway.pixazo.ai/v2/requests/status/fashn-virtual-try-on_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

Response (Completed)

{
  "request_id": "fashn-virtual-try-on_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "COMPLETED",
  "model_id": "fashn-virtual-try-on",
  "error": null,
  "output": {
    "media_url": [
      "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/v1/fashn-virtual-try-on_019dxxxx-xxxx/output.ext"
    ],
    "media_type": "application/octet-stream"
  },
  "created_at": "2026-03-31T10:00:00.000Z",
  "updated_at": "2026-03-31T10:00:15.000Z",
  "completed_at": "2026-03-31T10:00:15.000Z"
}

Response Fields

Field	Type	Description
request_id	string	Unique request identifier
status	string	QUEUED, PROCESSING, COMPLETED, FAILED, or ERROR
model_id	string	Model that processed the request
error	string\|null	Error message if failed
output.media_url	array	URLs to generated media (R2 CDN)
output.media_type	string	MIME type of the output
created_at	string	When request was created
completed_at	string\|null	When request completed
polling_url	string	Status URL (initial response only)

Status Values

Status	Description
QUEUED	Request accepted, waiting to be processed
PROCESSING	Being processed by the model
COMPLETED	Done — output contains the result
FAILED	Failed — check error field
ERROR	System error — not charged

Status Flow

QUEUED → PROCESSING → COMPLETED
                    → FAILED
                    → ERROR

Typical Workflow

Send a generate request to the API endpoint
Save the request_id from the response
Poll every 5-10 seconds: GET /v2/requests/status/{request_id}
When status is "COMPLETED", download from output.media_url

Tip: Use X-Webhook-URL header to get a callback instead of polling.

Fashn v1.6 API Pricing

Your request will cost $0.075 per try-on image.

2. Glass v1

Glass v1 API Documentation

https://gateway.pixazo.ai/glass-virtual-try-on/v1/api/glass-virtual-tryon

Generate - Pixazo Accessories-VTON

Request Code

POST https://gateway.pixazo.ai/glass-virtual-try-on/v1/api/glass-virtual-tryon
Content-Type: application/json
Cache-Control: no-cache
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY

{
  "model_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/model.png",
  "glass_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Capturade-tela-2025-07-17%20171034.png"
}

import requests

url = "https://gateway.pixazo.ai/glass-virtual-try-on/v1/api/glass-virtual-tryon"
headers = {
    "Content-Type": "application/json",
    "Cache-Control": "no-cache",
    "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}
data = {
    "model_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/model.png",
    "glass_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Capturade-tela-2025-07-17%20171034.png"
}

response = requests.post(url, json=data, headers=headers)
print(response.json())

const url = 'https://gateway.pixazo.ai/glass-virtual-try-on/v1/api/glass-virtual-tryon';

const data = {
  model_image_path: 'https://pub-582b7213209642b9b995c96c95a30381.r2.dev/model.png',
  glass_image_path: 'https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Capturade-tela-2025-07-17%20171034.png'
};

fetch(url, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Cache-Control': 'no-cache',
    'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
  },
  body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

curl -v -X POST "https://gateway.pixazo.ai/glass-virtual-try-on/v1/api/glass-virtual-tryon" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--data-raw '{
  "model_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/model.png",
  "glass_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Capturade-tela-2025-07-17%20171034.png"
}'

Output

{
  "success": true,
  "request_id": "abc-123-xyz",
  "status": "submitted"
}

Try Now

Request Parameters - Generate

Parameter	Required	Type	Default	Allowed values / range	Description
model_image_path	Yes	string	—	—	Image of the person who will wear the glasses. Pass a publicly accessible image URL or a Base64 data URI (include the data:image/png;base64, prefix). Use a clear photo of the face for best results.
glass_image_path	Yes	string	—	—	Image of the glasses (spectacles) to place on the person. Pass a publicly accessible image URL or a Base64 data URI (include the data:image/png;base64, prefix).
num_images	No	integer	1	1–4	Number of try-on images to generate per request.
output_format	No	string	jpeg	jpeg, png	File format of the generated image(s).

Example Request

{
  "model_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/model.png",
  "glass_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Capturade-tela-2025-07-17%20171034.png"
}

Response

{
  "success": true,
  "request_id": "abc-123-xyz",
  "status": "submitted",
  "message": "Request submitted"
}

Request Headers

Header	Value
Content-Type	application/json
Cache-Control	no-cache
Ocp-Apim-Subscription-Key	YOUR_SUBSCRIPTION_KEY

Response Handling

Common status codes for Generate.

Code	Meaning
200	Success
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
429	Too Many Requests
500	Internal Server Error

Retrieving Image Result and URL

After submitting your request, use this endpoint to check status and retrieve results.

Endpoint

POST https://gateway.pixazo.ai/glass-virtual-try-on-polling/api/glass-virtual-tryon-result

Request Body

{ "request_id": "abc-123-xyz" }

Request Code

POST https://gateway.pixazo.ai/glass-virtual-try-on-polling/api/glass-virtual-tryon-result
Content-Type: application/json
Cache-Control: no-cache
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY

{
  "request_id": "abc-123-xyz"
}

import requests

url = "https://gateway.pixazo.ai/glass-virtual-try-on-polling/api/glass-virtual-tryon-result"
headers = {
    "Content-Type": "application/json",
    "Cache-Control": "no-cache",
    "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}
data = {
    "request_id": "abc-123-xyz"
}

response = requests.post(url, json=data, headers=headers)
print(response.json())

const url = 'https://gateway.pixazo.ai/glass-virtual-try-on-polling/api/glass-virtual-tryon-result';

const data = {
  request_id: 'abc-123-xyz'
};

fetch(url, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Cache-Control': 'no-cache',
    'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
  },
  body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

curl -v -X POST "https://gateway.pixazo.ai/glass-virtual-try-on-polling/api/glass-virtual-tryon-result" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--data-raw '{
  "request_id": "abc-123-xyz"
}'

Response

{
  "request_id": "abc-123-xyz",
  "status": "completed",
  "image_url": "https://result-url.example.com/image.jpg",
  "content_type": "image/jpeg",
  "file_size": 174795
}

Glass v1 API Pricing

Your request will cost $0.30 per try-on image.

Image to Image (Virtual Try On)

Glass v1 API Documentation

https://gateway.pixazo.ai/glass-virtual-try-on/v1/api/glass-virtual-tryon

Glass Virtual Try On - Pixazo Accessories-VTON

Request Code

POST https://gateway.pixazo.ai/glass-virtual-try-on/v1/api/glass-virtual-tryon
Content-Type: application/json
Cache-Control: no-cache
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY

{
  "model_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/model.png",
  "glass_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Capturade-tela-2025-07-17%20171034.png",
  "num_images": 1,
  "output_format": "jpeg"
}

import requests

url = "https://gateway.pixazo.ai/glass-virtual-try-on/v1/api/glass-virtual-tryon"
headers = {
    "Content-Type": "application/json",
    "Cache-Control": "no-cache",
    "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}
data = {
    "model_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/model.png",
    "glass_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Capturade-tela-2025-07-17%20171034.png",
    "num_images": 1,
    "output_format": "jpeg"
}

response = requests.post(url, json=data, headers=headers)
print(response.json())

const url = 'https://gateway.pixazo.ai/glass-virtual-try-on/v1/api/glass-virtual-tryon';

const data = {
  model_image_path: 'https://pub-582b7213209642b9b995c96c95a30381.r2.dev/model.png',
  glass_image_path: 'https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Capturade-tela-2025-07-17%20171034.png',
  num_images: 1,
  output_format: 'jpeg'
};

fetch(url, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Cache-Control': 'no-cache',
    'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
  },
  body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

curl -v -X POST "https://gateway.pixazo.ai/glass-virtual-try-on/v1/api/glass-virtual-tryon" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--data-raw '{
  "model_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/model.png",
  "glass_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Capturade-tela-2025-07-17%20171034.png",
  "num_images": 1,
  "output_format": "jpeg"
}'

Output

{
  "success": true,
  "request_id": "abc-123-xyz",
  "status": "submitted",
  "message": "Request submitted"
}

Try Now

Request Parameters - Glass Virtual Try On

Parameter	Required	Type	Default	Allowed values / range	Description
model_image_path	Yes	string	—	—	Image of the person who will wear the glasses. Pass a publicly accessible image URL or a Base64 data URI (include the data:image/png;base64, prefix). Use a clear photo of the face for best results.
glass_image_path	Yes	string	—	—	Image of the glasses (spectacles) to place on the person. Pass a publicly accessible image URL or a Base64 data URI (include the data:image/png;base64, prefix).
num_images	No	integer	1	1–4	Number of try-on images to generate per request.
output_format	No	string	jpeg	jpeg, png	File format of the generated image(s).

Example Request

{
  "model_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/model.png",
  "glass_image_path": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Capturade-tela-2025-07-17%20171034.png",
  "num_images": 1,
  "output_format": "jpeg"
}

Response

{
  "success": true,
  "request_id": "abc-123-xyz",
  "status": "submitted",
  "message": "Request submitted"
}

Request Headers

Header	Value
Content-Type	application/json
Cache-Control	no-cache
Ocp-Apim-Subscription-Key	YOUR_SUBSCRIPTION_KEY

Response Handling

Common status codes for Glass Virtual Try On.

Code	Meaning
200	Success
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
429	Too Many Requests
500	Internal Server Error

Glass v1 API Pricing

Your request will cost $0.30 per try-on image.