Appearance
Uwear.ai API Documentation
Uwear.ai API allows you to call our AI models from your application. Upload clothing images and generate visuals of AI generated humans wearing them in seconds. You can also upscale generated images or create short videos from them.
Our API is always up to date with our latest AI models. Since April 3rd, 2025, we're using Drape2, which features increased realism and consistency with clothing. Users should expect regular improvements in clothing fidelity and overall photo quality in the coming months. Learn more at https://uwear.ai/announcing-drape2.
Quick Links
- Dev Portal - Create your account and get your API credentials
- Community - Join the Uwear.ai community and get help
- Direct Support - Connect directly with our team
Getting Started
To get started with the Uwear.ai API:
- Sign up at dev.uwear.ai to get your API credentials
- Keep your API keys secure and never share them
- Purchase API credits
Warning: API credits can only be used to make API calls. They cannot be used on the virtual studio webapp and vice versa.
Understanding Generation Process
- Two main ways to use the API:
- Upload clothing items first, then use their IDs in generation requests.
- Upload clothing items directly within a generation request.
- Clothing Item Upload:
use_image_enhancement: true
(default): Costs 1 credit. We process the item (remove background, generate descriptions).use_image_enhancement: false
: Costs 0 credits. Use your image and descriptions as-is. Best for pre-cleaned flat lays with good descriptions, as quality impacts results.- Uploading the same image URL multiple times reuses the existing processed item without extra charges.
- Direct Upload Tradeoff: Uploading an item directly in a generation request makes that specific request slower due to the required item processing before generation starts.
- Generation Requests: Specify details like image count, camera angle, and model description.
enhance_user_prompt: true
(default): Our AI refines your prompt for better results.enhance_user_prompt: false
: Use your exact prompt (only if well-crafted).
- Generation Results: Once submitted, requests initiate the creation of Generation Results containing the AI images. See the section below on how to monitor status and retrieve results. Completion typically takes 5 seconds per image. Generated images are delivered in PNG format with 704 x 1024 pixel resolution.
- Retrieving Generation Results:
- Method 1: Polling Specific Details: Call
Get Generation Details
using the ID of your generation request. Monitor thestatus
field. Once the status indicates completion (e.g., "completed"), the response will contain the Generation Results, including URLs to the generated images. - Method 2: Listing Filtered Results: Call
Get All Generation Results
and use the generation request ID as a filter parameter. This allows retrieving results without needing to poll the status individually. - Choosing a Method: The best approach depends on your workflow. Polling is suitable if you need to track the progress of a specific request closely. Listing is useful for retrieving results for known completed requests or batch processing.
- Method 1: Polling Specific Details: Call
- Sequential Processing: Multiple requests are processed one after another (concurrent generation is planned).
- Image Expiry: Generated images are available for 4 hours.
- New Features: After generating an image, you can upscale it for higher resolution or create a short video based on it.
Pricing
Our API uses a credit-based system. Purchase credits via our dev portal.
Operation Type | Price per Operation | Notes |
---|---|---|
Clothing Upload (enhanced) | 1 credit (0.15USD) | Costs 1 credit if use_image_enhancement is true (default). We process the item (remove background, generate descriptions). |
Clothing Upload (non-enhanced) | 0 credit (0.00USD) | No charge if use_image_enhancement is false. Requires a clean image and good descriptions from you. |
Image Generation | 1 credit (0.15USD) | Credits charged only for successful generations. Failed requests are recredited automatically. |
Image Upscaling | 1 credit (0.15USD) | Upscale a generated image to a higher resolution. |
Video Generation (5 seconds) | 5 credits (0.75USD) | Create a 5-second video from a generated image. |
Video Generation (10 seconds) | 10 credits (1.50USD) | Create a 10-second video from a generated image. |
Enterprise Scale
For enterprise solutions including increased API quotas and custom integrations with our AI models, please contact us at hello@uwear.ai.