Apiway documentation
Reference and how-to docs for every part of Apiway — Creative templates, the Creators marketplace, billing, the gallery, and legal/compliance. Written to be precise, quotable, and never invented.
Getting started
What is Apiway?
Apiway is a fashion-built AI platform for generating product, catalog, and creative imagery — White Studio photoshoots, ghost mannequin, virtual try-on, and a Creators marketplace of real photo sets. Here is the 60-second overview.
Sign up and log in
Apiway accepts Google OAuth and email + password (with one-time-code email verification on registration). Here is how to register, log in, and recover access.
Brand vs Creator role: pick your starting view
After registration Apiway asks you to pick a role — Brand/SMM (you make ads with AI) or Creator/Photographer (you sell photo sets on the marketplace). The role only switches the default UI; you can toggle it later from the sidebar or account page.
The free tier: 100 one-time credits
Every Apiway account starts on the Free plan with 100 one-time credits (no monthly refill). 1 credit = 1 US cent. Credits cover all Creative templates. Here is what 100 credits get you and how paid monthly tiers work after the free tier.
Your first generation in 3 minutes
End-to-end first run on Apiway: log in, open White Studio, upload a garment photo, pick a model and aspect ratio, hit Generate. From signup to result in under three minutes on the free tier.
Using Apiway with AI assistants (ChatGPT, Claude, Cursor, Codex)
Apiway publishes machine-readable copies of every doc, an llms.txt index, product-domain slices, an ai.txt citation manifest, and a Markdown twin (`.md`) of every doc page. Here is how AI assistants and code editors should retrieve Apiway documentation.
Templates
Creative templates: full list
Apiway's Creative hub has 9 user-facing templates — White Studio, Ghost Mannequin, Virtual Try-On, Creators UGC photo sets, Image from scratch, Reference Campaign, Batch Creation, Edit with Paint, and Post Production Filters. Here is what each does, the inputs, and the credit cost.
White Studio (AI Photoshoots)
White Studio generates a studio-quality fashion shot of your garment on a preset AI model, with a guaranteed pure white #FFFFFF background, multiple poses, and 9 aspect ratios. Here is what it does, what it accepts, and the per-generation cost.
Ghost Mannequin (Garment on Mannequin)
Ghost Mannequin converts a flat-lay, on-model, or on-mannequin garment photo into a clean ghost-mannequin shot on a white background. Up to 50 garments in batch mode. Ideal for catalog tiles, Amazon, and Shopify PDP.
Virtual Try-On
Virtual Try-On takes a person photo and a garment photo and generates a believable on-model preview. Exactly two images required (one person + one garment). Use for product try-on imagery, lookbooks, and ads.
Creators UGC photo sets (Styled Photoset)
Styled Photoset uses a real creator photo as the base — your garment is overlaid onto a marketplace creator's curated frame. The output looks like real UGC because the human and environment are real; only the garment is generated. Two or more files required (first = creator frame, rest = garment).
Fashion image from scratch
Image Creation generates a fashion image from a text prompt and optional reference photos — no garment upload required. Pick from 9 aspect ratios and up to 4 variants per generation. Great for moodboards, ads, and concept exploration.
Reference Campaign AI Photoshoots (beta)
Reference Campaign is a 3-step photoshoot flow that builds an entire campaign from a reference creative direction. Beta. Step 1 generates a model reference; steps 2–3 dress and finalize. Includes interior blueprint (≤ 48k chars) and studio blueprint (≤ 32k chars) text inputs.
Batch Creation
Batch Creation runs Image Creation against up to 50 input photos in a single request — same prompt, same settings, applied across the batch. Cost scales with the number of variants per output (1–4). Useful for SKU-velocity catalog work.
Edit with Paint (beta)
Edit lets you mark a region on an existing image and prompt a change — "replace the dress with a red one," "remove the background object," "swap shoes." Requires the original image plus a paint mask (2–7 inputs). Tracked as processing rather than a fresh generation.
Post Production Filters (beta)
Post Production runs entirely client-side adjustments — exposure, contrast, white balance, sharpening, export — without spending credits on a generation. Use for last-mile tweaks before publishing.
Workflows
Workflow: Amazon main image with pure white #FFFFFF
Amazon's main image policy is unambiguous: RGB 255/255/255 background, garment fully visible, no other elements. Here is the Apiway workflow that ships compliant Amazon main images consistently — White Studio + the pure-white post-processing pipeline.
Workflow: Shopify PDP at 4:5 aspect ratio
Shopify product pages render best at 4:5 portrait. Here is the Apiway workflow for a coherent multi-look PDP — White Studio for the catalog hero, Virtual Try-On for the lifestyle alt, consistent identity across both.
Workflow: Instagram content pack (9:16, 4:5, 1:1)
Each Instagram surface has its own aspect ratio. This workflow generates a single coherent fashion concept across Stories (9:16), feed (4:5), and grid (1:1) using the same model identity for visual consistency.
Workflow: TikTok UGC ads with creator photo sets
TikTok rewards content that feels like a real person. Polished studio creative underperforms creator-style imagery on the platform. Use the Creators marketplace + Styled Photoset to ship UGC-style fashion ads that read as authentic.
Workflow: Capsule lookbook in a weekend
Forty looks across a 10-SKU capsule, generated over a weekend. Project plan, tool stack, time budget — White Studio for the catalog spine, Image Creation for moodboard alts, Batch Creation for the long tail.
Workflow: when to use a marketplace creator vs your own AI model
Two ways to put your garment on a person in Apiway: pick a preset AI model in White Studio, or rent a real creator photo set on the Marketplace. Here is the decision rule per use case — catalog, lifestyle, ads, lookbook — including the legal/licensing implications.
Creators marketplace
How to publish a photo set on the Creators marketplace
Publish a curated fashion photo set to the Apiway Creators marketplace and earn credits every time a brand uses it in a generation. Here is the upload flow, the curation guidelines, and what to set on first listing.
How to sell an AI avatar on the marketplace
An avatar listing lets brands use your face/identity as the AI model in White Studio and Reference Campaign. Different from a photo set: a single subject, multiple poses. Here is the avatar listing flow.
How to sell a reference (Reference Campaign listing)
Reference listings power the Reference Campaign template — multi-step campaign creative built on top of your reference frames. Here is when to publish a reference listing instead of a photo set or avatar.
Co-authors and revenue split rules
Every marketplace listing supports up to 5 co-authors with a configurable credit split. Each co-author share must be ≥ 1 credit. The owner share can be 0 if 100% goes to co-authors. Here are the exact rules and common split patterns.
Pricing rules: creator pool and buyer price
Creators set a creator pool price (minimum 5 credits) per generation. The buyer pays the creator pool plus a marketplace markup (default 20%). All amounts denominated in credits, where 1 credit = $0.01. Here is the math.
How to withdraw earnings (payout)
Marketplace earnings accrue to a separate balance, distinct from your generation credits. Withdrawal is currently a manual flow: from the Earnings tab, request a withdrawal and the Apiway team contacts you by email to process the payout (PayPal or alternative).
Account & Billing
Plans and credits (full table)
Apiway's seven plans (1 credit = $0.01): Free — 100 one-time credits, $0; paid tiers (credits per month / USD): Starter 1,000 / $10, Basic 3,000 / $29, Pro 6,000 / $49, Studio 14,000 / $99, Business 38,000 / $249, Scale 80,000 / $490. Here is the full table and what each plan includes.
How to upgrade your plan
Plan upgrades go through Stripe Checkout. From the Billing tab, pick a plan, click Upgrade, complete checkout. Apiway syncs the subscription on the success redirect and grants the new plan's credits within seconds.
How to cancel or downgrade your subscription
Cancel your Apiway subscription from the Billing tab — Cancel Subscription stays active until the end of the current billing period, then drops to Free (100 credits/mo). For mid-cycle changes use the Stripe customer portal.
Invoices and the Stripe customer portal
Apiway lists every Stripe invoice in the Billing tab — download as PDF, view individual line items, or open the Stripe customer portal for payment-method updates and full billing history.
Gallery & Downloads
Finding your generated images
Every generation saves to your private gallery at /app/gallery. Filter by template, date, or asset type. Each image has a permalink usable inside Apiway and a download endpoint accessible only to the owner.
Download formats and resolutions
Resolution (1K, 2K, 4K) is set at generation time — there is no separate download-resolution toggle. Files are served as PNG by default; underlying mime-type matches what the model produced. Worker-generated images redirect to a 5-minute presigned S3 URL.
Sharing images via public folders
Apiway supports public-folder sharing for client review and lookbook handoff — separate from the owner-only download endpoint. Public folders live at /gallery/p/<folderId> and /g/<slug>.
Troubleshooting
Generation failed: did I lose my credits?
When a generation fails after credits were deducted, Apiway automatically calls try_refund_credits with the same amount and the same source (plan or marketplace) within seconds. Here is what to check, and what to do if you still see the wrong balance.
Upload too large or too many files
API limits per generation request: 60 MB per file, 200 MB total. Per-template slot limits: ghost mannequin / image-creation 3 (flash) or 10 (pro / nano-banano-2); virtual try-on exactly 2; styled photoset ≥ 2 / ≤ 10; reference photoshoot ≤ 10; batch up to 50.
"Try again in 30 seconds" / heavy queue busy
Heavy templates (ai-photoshoots, ghost-mannequin, batch flags, multi-variant ai-model and image-creation) run one at a time per server process. If you hit the heavy queue, you'll see a 503 with a 30-second retry hint. The /api/generate rate limit is 60 requests per user per minute.
Legal & Compliance
Commercial use rights for generated images
All paid plans (Starter and above) include commercial-use rights on every image you generate. The Free plan also permits commercial use but with attribution recommended. Marketplace generations carry the photographer's and model's licensing trail end-to-end.
Why you should not upload random Pinterest photos to AI
Using a copyrighted photo (Pinterest, Instagram, Google Images) as input to an AI fashion tool and shipping the result as a commercial ad creates legal exposure: copyright on the original photo, right of publicity / personality rights on the depicted person, and platform-policy strikes on Meta/TikTok/Google Ads. Use the Creators marketplace instead.
Marketplace licensing trail (the safe alternative)
When you generate against a Creators marketplace photo set, the photographer has certified the upload + model release; the model is named as a co-author and is paid per generation. Every party in the chain is paid; every right is licensed; the platform documents the trail.