API Documentation

Integrate VistoureAI's world-class generational models natively into your retail, e-commerce, or creative applications in minutes.

Developer Friendly

Predictable asynchronous architecture. Hand off intensive workloads instantly, track status reliably, and get results when ready.

Secure by Design

All REST interactions require encrypted AES Bearer authentication. Your models and clothing IP are rigorously sandboxed.

3-Day Retention

Outputs are intelligently cached via CDN for lightning fast delivery and natively retained on our secure S3 cluster for 3 days.

Authentication

All endpoints under /api/v2/* require your API key passed in the headers. You can generate one inside the Developer API Dashboard.

X-API-KEY: <your_api_key_here>

Virtual Try-On

Generate virtual try-on images fusing a model and a garment.

POST/api/v2/tryon/run

Initiate an asynchronous virtual try-on generation.

Parameters

Parameter	Type	Description
categoryRequired	string	Category of clothing. Allowed: 'top', 'bottom', 'dresses'
model_imageRequired	string	URL or base64 string of the fashion model.
garment_imageRequired	string	URL or base64 string of the garment/clothing.
garment_description	string	Optional text description to guide the generation (e.g. 'black leather jacket').
seed	integer	Random seed for reproducible generations.
model_name	string	Type of model: Beta, Turbo.

Request Body Example

JSON

{
  "category": "top",
  "model_image": "https://example.com/model.jpg",
  "garment_image": "https://example.com/item.jpg",
  "seed": 42,
  "model_name": "Beta"
}

Expected Response

JSON200 OK

{
  "id": "gen_12345abcd",
  "error": null
}

GET/api/v2/tryon/status/{run_id}

Poll this endpoint using the generated request ID to retrieve the resulting image once 'status' is 'completed'.

Expected Response

JSON200 OK

{
  "id": "gen_12345abcd",
  "status": "completed",
  "output": ["https://example.com/result.png"],
  "error": null,
  "input": { ... },
  "model_name": "Turbo"
}

Try-On Pro

High-fidelity precise try-on engineered for professional use.

POST/api/v2/tryon/pro/run

Initiate our most advanced Try-On Pro engine for flawless garment draping. Supports Pro Fit parameters.

Parameters

Parameter	Type	Description
categoryRequired	string	Category of clothing. Allowed: 'top', 'bottom', 'dress', 'accessory'.
model_imageRequired	string	URL or base64 string of the fashion model.
garment_imageRequired	string	URL or base64 string of the garment.
model_name	string	Pass 'Pro Fit' to use the precise sizing model, or leave blank/pass 'Pro' for standard Pro.
garment_size	string	Only utilized if model_name='Pro Fit'. Sizes: 'S', 'M', 'L', 'XL'.
aspect_ratio	string	Aspect ratio, e.g., '3:4', '1:1', '16:9'. Default: '3:4' or 'match_input_image' based on model.
pose_image	string	Optional URL/base64 of a pose reference.
style_image	string	Optional URL/base64 of a style reference.

Request Body Example

JSON

{
  "category": "top",
  "model_image": "https://example.com/model.jpg",
  "garment_image": "https://example.com/item.jpg",
  "model_name": "Pro Fit",
  "garment_size": "M",
  "aspect_ratio": "3:4"
}

Expected Response

JSON200 OK

{
  "id": "gen_pro_44444",
  "error": null
}

GET/api/v2/tryon/pro/status/{run_id}

Check generation status for your Try-On Pro request.

Expected Response

JSON200 OK

{
  "id": "gen_pro_44444",
  "status": "completed",
  "output": ["https://example.com/result.png"],
  "error": null,
  "model_name": "Pro"
}

Virtual Model

Generate highly photorealistic fashion models entirely from text descriptions.

POST/api/v2/virtualmodel/run

Submit a request to generate a person based on specific physical characteristics and backgrounds.

Parameters

Parameter	Type	Description
model_nameRequired	string	Engine choice. Allowed: 'Standard', 'Pro', 'Plus'.
ethnicityRequired	string	Ethnicity of the model (e.g., 'Caucasian', 'Asian').
genderRequired	string	Gender of the model ('Female', 'Male').
dresstypeRequired	string	Style of dress or fashion worn by the model.
backgroundRequired	string	Environment/background description.
age	string	Age bracket (e.g., 'Adult', 'Young Adult'). Default: 'Adult'.
improve_prompt	string	Additional stylistic modifiers.
closeup	boolean	Set to true for a tight framing portrait.
face_reference	string	URL/base64 image of a face to preserve features (Pro/Plus only).
num_outputs	integer	Number of variations to generate (max 4 on Standard).

Request Body Example

JSON

{
  "model_name": "Standard",
  "ethnicity": "Caucasian", 
  "gender": "Female",
  "age": "Adult",
  "dresstype": "Casual streetwear",
  "background": "Urban city street",
  "num_outputs": 1
}

Expected Response

JSON200 OK

{
  "id": "gen_model_987xyz",
  "error": null
}

GET/api/v2/virtualmodel/status/{run_id}

Retrieve your newly generated model image variations.

Expected Response

JSON200 OK

{
  "id": "gen_model_987xyz",
  "status": "completed",
  "output": ["https://example.com/result.png"],
  "error": null
}

Fabric Change

Change the fabric or texture of an existing garment realistically while preserving original lighting.

POST/api/v2/fabric/run

Submit an image of a model, alongside the target fabric to be wrapped.

Parameters

Parameter	Type	Description
categoryRequired	string	Category to replace. Allowed: 'top', 'bottom', 'dress'.
model_imageRequired	string	Base image of the model.
fabric_image	string	Image of the fabric/texture. Required unless fabric_description is provided.
fabric_description	string	Text description of the desired fabric pattern.
upscale	boolean	Set to true to upscale the final result.

Request Body Example

JSON

{
  "category": "dress",
  "model_image": "https://example.com/base.jpg",
  "fabric_image": "https://example.com/velvet.jpg",
  "upscale": false
}

Expected Response

JSON200 OK

{
  "id": "gen_fab_10101",
  "error": null
}

GET/api/v2/fabric/status/{run_id}

Retrieve the generated model wearing the newly textured garment.

Expected Response

JSON200 OK

{
  "id": "gen_fab_10101",
  "status": "completed",
  "output": "https://example.com/result.png",
  "error": null
}

Sketch to Dress

Bring flat fashion sketches or line art to life by converting them into photorealistic garments.

POST/api/v2/sketchtodress/run

Upload a sketch. AI infers the 3D volume, material, and shading.

Parameters

Parameter	Type	Description
imageRequired	string	URL/base64 of the fashion sketch.
gender	string	Gender presentation. Allowed: 'female', 'male'. Default: 'female'.
mode	string	Mode of the operation: 'draw' or 'upload'. Default: 'draw'.
improve_prompt	string	Textural instructions like 'red silk with gold trim'.

Request Body Example

JSON

{
  "image": "https://example.com/sketch.jpg",
  "gender": "female",
  "mode": "draw",
  "improve_prompt": "Red satin cocktail dress with shiny reflection"
}

Expected Response

JSON200 OK

{
  "id": "gen_sk_4022",
  "error": null
}

GET/api/v2/sketchtodress/status/{run_id}

Poll for the photorealistic image.

Expected Response

JSON200 OK

{
  "id": "gen_sk_4022",
  "status": "completed",
  "output": ["https://example.com/result.png"],
  "error": null
}

User Tokens

Retrieve your underlying token balance to programmatically track API utility.

GET/api/v2/user/tokens

Fetch current token balance across your VistoureAI account.

Expected Response

JSON200 OK

{
  "tokens": 42500
}