{"info":{"_postman_id":"1087301e-9a5d-4f03-ac9f-c8643acf2c6b","name":"Welcome to Yeah Sure's Virtual Try-on API","description":"<html><head></head><body><p><strong>Yeah Sure is an AI that helps you do virtual try-on for clothing.</strong></p>\n<hr>\n<p>Yeah Sure's Virtual Try-on API allows you to virtually create styles using images with different outfits and clothes. With Yeah Sure's API you can try-on top wear, bottom wear and full-body garments on your own images, images of human models, and even images of AI generated humans.</p>\n<p>Yeah Sure's API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.</p>\n<p><strong>You have two ways to generate clothing styles:</strong></p>\n<ol>\n<li><p>You can use your own model image and garment image.</p>\n</li>\n<li><p>You can select from a pre-existing library of model images and garment images.</p>\n</li>\n</ol>\n<h2 id=\"getting-started-guide\"><strong>Getting started guide</strong></h2>\n<p><code>Current version:</code> <strong><code>v1.0</code></strong></p>\n<p>Using Yeah Sure's Virtual Try-on API in your app can begin as soon as you create an account on Yeah Sure's webapp. It takes less than a minute to set up your development environment:</p>\n<ol>\n<li><p>Create an account on <a href=\"https://app.yeahsure.ai\">app.yeahsure.ai</a></p>\n</li>\n<li><p>Click on \"Settings\" in the sidebar</p>\n</li>\n<li><p>Click \"Create API Key\"</p>\n</li>\n<li><p>Click \"Add key\" to create a new API key</p>\n</li>\n</ol>\n<p>You can create upto two API keys - one for staging and one for production.</p>\n<p>To start using the APIs, you need to -</p>\n<ul>\n<li><p>You must use a valid API Key to send requests to the API endpoints.</p>\n</li>\n<li><p>The API has rate and usage limits.</p>\n</li>\n<li><p>The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.</p>\n</li>\n<li><p>The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.</p>\n</li>\n</ul>\n<h2 id=\"authentication\">Authentication</h2>\n<ul>\n<li><p>Yeah Sure uses API Keys for authentication.</p>\n</li>\n<li><p>You can generate a Postman API key in the API keys section of your Yeah Sure account settings.</p>\n</li>\n<li><p>You must include an API key in each request to the Postman API with the X-Api-Key request header.</p>\n</li>\n<li><p><strong>Authentication error response:</strong> If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.</p>\n</li>\n</ul>\n<h2 id=\"rate-and-usage-limits\">Rate and usage limits</h2>\n<ul>\n<li><p>API access rate limits apply at a per-API key basis in unit time. The limit is <strong>50 requests per minute</strong>.</p>\n</li>\n<li><p>Depending on your plan, you may have usage limits.</p>\n</li>\n<li><p>If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.</p>\n</li>\n<li><p>Each API response returns the following set of headers to help you identify your use status:</p>\n</li>\n</ul>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Header</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>X-RateLimit-Limit</code></td>\n<td>The maximum number of requests that the user is permitted to make per minute.</td>\n</tr>\n<tr>\n<td><code>X-RateLimit-Remaining</code></td>\n<td>The number of requests remaining in the current rate limit window.</td>\n</tr>\n<tr>\n<td><code>X-RateLimit-Reset</code></td>\n<td>The time at which the current rate limit window resets in UTC epoch seconds.</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"503-response\">503 response</h3>\n<ul>\n<li><p>An HTTP <code>503</code> response from our servers indicates there is an unexpected spike in API access traffic.</p>\n</li>\n<li><p>The server is usually operational within the next five minutes.</p>\n</li>\n<li><p>If the outage persists or you receive any other form of an HTTP <code>5XX</code> error, contact support.</p>\n</li>\n</ul>\n<h3 id=\"need-some-help\"><strong>Need some help?</strong></h3>\n<p>In case you have questions, go through our tutorials. Or visit our FAQ page.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"42627426","collectionId":"1087301e-9a5d-4f03-ac9f-c8643acf2c6b","publishedId":"2sAYdeMsEF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FC5071"},"publishDate":"2025-02-27T18:16:30.000Z"},"item":[{"name":"Virtual Try-on API Endpoints","item":[{"name":"Generate new image","event":[{"listen":"test","script":{"id":"e3e7c8cf-42bc-4c24-b406-d32173fc1c46","exec":[""],"type":"text/javascript","packages":{}}}],"id":"024a0f51-5539-413d-a37c-f22959fd960d","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"ys-api-key"},{"key":"value","value":"{{YeahSureAPIKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"ys-api-key","value":"{{YeahSureAPIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"inputType\": \"virtual-try-on\",\n    \"tryonClothingStyle\": \"full-body\",\n    \"personImage\": {{person_image_public_url}},\n    \"clothImage\": {{cloth_image_public_url}},\n    \"callbackUrl\": {{callback_url}}\n}"},"url":"https://api.yeahsure.ai/v1/generate","description":"<p>Generates a new image from two inputs - images of clothes/outfits and images people you want to style.</p>\n<p><strong>Required headers:</strong></p>\n<p><code>Content-Type</code>: <code>application/json</code></p>\n<p><code>ys-api-key</code>: <code>{{YeahSureAPIKey}}</code> (retrieved from YeahSure AI)</p>\n<p><strong>Request Body (JSON):</strong></p>\n<ul>\n<li><p><code>personImage</code> (<strong>required</strong>) — Publicly accessible URL of the model image.</p>\n</li>\n<li><p><code>clothImage</code> (<strong>required</strong>) — Publicly accessible URL of the cloth image.</p>\n</li>\n<li><p><code>inputType</code> (optional) — Type of image generation, by default this value is set to “virtual-try-on”</p>\n</li>\n<li><p><code>tryonClothingStyle</code> (optional) — Type of clothing that is uploaded by the user, by default this value is set to “full-body”</p>\n</li>\n<li><p><code>callbackUrl</code> (optional) — Callback URL to be triggered when the style is generated.</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["v1","generate"],"host":["api","yeahsure","ai"],"query":[],"variable":[]}},"response":[{"id":"8369511e-70a6-4344-87d6-c1eab632e594","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"ys-api-key","value":"YeahSureAPIKey","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"inputType\": \"virtual-try-on\",\n    \"tryonClothingStyle\": \"full-body\",\n    \"personImage\": \"https://storage.cloud.google.com/potion-tryon-staging/preset-input-images/user_2rkbHkI2CyW51f5dTv1z8Vpu72C_67a207ece56d26539c852aed_person_1738672108547_0.png\",\n    \"clothImage\": \"https://storage.cloud.google.com/potion-tryon-staging/garment_input/user_2tH6g08SiP0fBWbIOKaybthhSDT_67b839c641a3cde2cbcccc54_cloth_1740126662474.jpg\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.yeahsure.ai/v1/generate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"67bbf866fcc1358aac28dcas8\",\n    \"createdAt\": 1111111111,\n    \"monthlyCreditsRemaining\": 100\n}"}],"_postman_id":"024a0f51-5539-413d-a37c-f22959fd960d"},{"name":"Get an image","event":[{"listen":"test","script":{"id":"07bbee89-8c34-4862-b91b-1a0b89aa3df2","exec":[""],"type":"text/javascript","packages":{}}}],"id":"fdb0f10f-94c6-41a0-a9ae-ca41b7c2541e","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"ys-api-key","value":"YeahSureAPIKey","type":"text"}],"url":"https://api.yeahsure.ai/v1/fetch/{{generatedImageId}}","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"89101499-c5f8-487a-b3ca-2644db8f0aa0","id":"89101499-c5f8-487a-b3ca-2644db8f0aa0","name":"Virtual Try-on API Endpoints","type":"folder"}},"urlObject":{"protocol":"https","path":["v1","fetch","{{generatedImageId}}"],"host":["api","yeahsure","ai"],"query":[],"variable":[]}},"response":[{"id":"0eac1487-84bd-45c8-b064-29e43c9d972c","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"ys-api-key","value":"YeahSureAPIKey","type":"text"}],"url":"https://api.yeahsure.ai/v1/fetch/67bbf866fcc1358aac28dc8c"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"67bbf866fcc1358aac28dc8c\",\n    \"personModelImageUrl\": \"https://storage.cloud.google.com/potion-tryon-staging/preset-input-images/user_2rkbHkI2CyW51f5dTv1z8Vpu72C_67a207ece56d26539c852aed_person_1738672108547_0.png\",\n    \"tryonClothingImageUrl\": \"https://storage.googleapis.com/potion-tryon-staging/preset-input-images/user_2rkbHkI2CyW51f5dTv1z8Vpu72C_67a20843e56d26539c852b2f_clothing_1738672195274_0.png\",\n    \"outputImages\": [\"https://storage.googleapis.com/potion-tryon-staging/output/user_2tH6g08SiP0fBWbIOKaybthhSDT_67bd2528cb0d1455e62e0069_0_output.png\"],\n    \"status\": \"success\",\n    \"createdAt\": \"2025-02-24T04:41:10.279Z\",\n    \"updatedAt\": \"2025-02-24T04:49:55.451Z\"\n}"},{"id":"2df58ecf-3448-495e-b594-faa9e22b5fbd","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"ys-api-key","value":"YeahSureAPIKey","type":"text"}],"url":"https://api.yeahsure.ai/v1/fetch/67bbf866fcc1358aac28dc8c"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"67bbf866fcc1358aac28akfn\",\n    \"status\": \"failed\"\n}"}],"_postman_id":"fdb0f10f-94c6-41a0-a9ae-ca41b7c2541e"},{"name":"Get all images","event":[{"listen":"test","script":{"id":"0b80d32d-7c86-42e2-aef5-d7a07878eb76","exec":[""],"type":"text/javascript","packages":{}}}],"id":"ae8247a6-7518-4626-8795-09042e0ca06c","request":{"method":"GET","header":[],"url":"https://api.yeahsure.ai/v1/fetch?page=0&limit=50","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"89101499-c5f8-487a-b3ca-2644db8f0aa0","id":"89101499-c5f8-487a-b3ca-2644db8f0aa0","name":"Virtual Try-on API Endpoints","type":"folder"}},"urlObject":{"protocol":"https","path":["v1","fetch"],"host":["api","yeahsure","ai"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"8f7b346a-c130-463a-96c7-f288ffa2a0a7","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"ys-api-key","value":"YeahSureAPIKey","type":"text"}],"url":{"raw":"https://api.yeahsure.ai/v1/fetch?page=0&limit=50","protocol":"https","host":["api","yeahsure","ai"],"path":["v1","fetch"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"50"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"[\n    {\n    \"id\": \"67bbf866fcc1358aac28dc8c\",\n    \"personModelImageUrl\": \"https://storage.cloud.google.com/potion-tryon-staging/preset-input-images/user_2rkbHkI2CyW51f5dTv1z8Vpu72C_67a207ece56d26539c852aed_person_1738672108547_0.png\",\n    \"tryonClothingImageUrl\": \"https://storage.googleapis.com/potion-tryon-staging/preset-input-images/user_2rkbHkI2CyW51f5dTv1z8Vpu72C_67a20843e56d26539c852b2f_clothing_1738672195274_0.png\",\n    \"outputImages\": [\"https://storage.googleapis.com/potion-tryon-staging/output/user_2tH6g08SiP0fBWbIOKaybthhSDT_67bd2528cb0d1455e62e0069_0_output.png\"],\n    \"status\": \"success\",\n    \"createdAt\": \"2025-02-24T04:41:10.279Z\",\n    \"updatedAt\": \"2025-02-24T04:49:55.451Z\"\n}\n]"}],"_postman_id":"ae8247a6-7518-4626-8795-09042e0ca06c"},{"name":"Delete an image","event":[{"listen":"test","script":{"id":"3e6c199f-d049-4c7f-92aa-71564be221c2","exec":[""],"type":"text/javascript","packages":{}}}],"id":"697d9340-84ff-4e45-9aa0-5d1e14aee7f3","request":{"method":"DELETE","header":[],"url":"https://api.yeahsure.ai/v1/delete/{{generatedImageId}}","description":"<p>Deletes a generated image.</p>\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"89101499-c5f8-487a-b3ca-2644db8f0aa0","id":"89101499-c5f8-487a-b3ca-2644db8f0aa0","name":"Virtual Try-on API Endpoints","type":"folder"}},"urlObject":{"protocol":"https","path":["v1","delete","{{generatedImageId}}"],"host":["api","yeahsure","ai"],"query":[],"variable":[]}},"response":[{"id":"228bbdc5-d2c4-48de-84ea-e0c873652399","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"ys-api-key","value":"YeahSureAPIKey","type":"text"}],"url":"https://api.yeahsure.ai/v1/delete/67bbf866fcc1358aac28dc8c"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"ced10e23-6eda-4b9e-8fa4-05b2686ba5ee","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"ys-api-key","value":"YeahSureAPIKey","type":"text"}],"url":"https://api.yeahsure.ai/v1/delete/67bbf866fcc1358aac28akfn"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"67bbf866fcc1358aac28akfn\",\n    \"status\": \"failed\"\n}"}],"_postman_id":"697d9340-84ff-4e45-9aa0-5d1e14aee7f3"}],"id":"89101499-c5f8-487a-b3ca-2644db8f0aa0","description":"<p><strong>baseUrl:</strong> <code>api.yeahsure.ai</code></p>\n<ul>\n<li><p>[<strong>POST</strong>] <code>/generate</code>: To generate a new image.</p>\n</li>\n<li><p>[<strong>GET</strong>] <code>/fetch/generated_image_id</code>: To retrieve a generated image by it's ID.</p>\n</li>\n<li><p>[<strong>GET</strong>] <code>/fetch?page={page_number}&amp;limit={pagination_limit}</code>: To retrieve all generated images with pagination.</p>\n</li>\n<li><p>[<strong>DELETE</strong>] <code>/fetch/generated_image_id</code>: To delete a generated image by it's ID.</p>\n</li>\n</ul>\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d75c5b32-937d-48c9-baab-608e9f619c0e","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"3c1c2787-af3e-4b83-8639-59143a2b5b93","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"89101499-c5f8-487a-b3ca-2644db8f0aa0"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{YeahSureAPKey}}"}]}},"event":[{"listen":"prerequest","script":{"id":"47cf967b-46ea-4f51-9e33-f21d3f1a3996","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"372d49af-4e08-43ae-ab9b-ed02b24987cd","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.yeahsure.ai\n"}]}