Endpoints
On this page you will find our HTTP API reference. Currently, we support 3 types of endpoints:
run- Run predictionstatus/:id- Get prediction status
Run prediction
Initiate a new try-on prediction by posting to the following endpoint:
POSThttps://api.fashn.ai/v1/run
Request
Properties:
model_imageRequiredimage URL | base64
garment_imageRequiredimage URL | base64
categoryRequired'tops' | 'bottoms' | 'one-pieces'
nsfw_filterboolean
Runs NSFW content filter on inputs.
Default: true
cover_feetboolean
Allows long garments to cover the feet/shoes or change their appearance.
Default: false
adjust_handsboolean
Allow to change the appearance of the model’s hands. Example use-cases: Remove gloves, get hands out of pockets, long sleeves that should cover hands.
Default: false
restore_backgroundboolean
Apply additional steps to preserve the original background. Runtime will be slower. Not needed for simple backgrounds.
Default: false
restore_clothesboolean
Apply additional steps to preserve the appearance of clothes that weren’t swapped (e.g. keep pants if trying-on top).
Default: false
garment_photo_typeauto | flat-lay | model
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.
Default: auto
long_topboolean
Adjusts internal parameters for better performance on long tops such as: Longline shirts, tunics, coats, etc.
Default: false
modeperformance | balanced | quality
Specifies the mode of operation.
-performance mode is faster but may compromise quality
-balanced mode is a perfect middle ground between speed and quality
-quality mode is slower, but delivers the highest quality results.
Default: balanced
seedint
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.
Default: 42
num_samplesint
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.
Default: 1 Range: 1-4
Response
The reponse will return the id of the prediction which you will need to use for getting the status and result.
Get prediction status
Receive the status of the prediction by id. Unless in a queue, it takes
up to 40 seconds to generate a try-on.
GEThttps://api.fashn.ai/v1/status/:id
Poll this endpoint to monitor the prediction’s progress and retrieve the final output once available.
Request
Response
The response will return the prediction id and status.
Status types can be one of the following:
statusstarting | in_queue | processing | completed | failed
Prediction in progress
Prediction completed
Rate Limits
/run- Up to 25 requests per 60 seconds/status- Up to 50 requests per 10 seconds
Our API rate limits are in place to ensure fair usage and prevent misuse of our services. However, we understand that legitimate applications may require higher limits as they grow. If your app’s usage nears the specified rate limits, and this usage is justified by your application’s needs, we will gladly increase your rate limit. Please reach out to our support@fashn.ai to discuss your specific requirements.
Privacy
Inputs and outputs generated through the API will be automatically deleted from our systems after 72 hours. However, you can still view the requests via the web app interface.