Frequently Asked Questions

Short answers to the questions we hear most from developers integrating the Fashio API.

Is this the same engine as the Fashio app?

Yes. The API and the Fashio app share the same generation pipeline and the same diamond credit balance on your account. There is no separate "API-only" model or quality tier — a call to POST /v1/generations runs through the exact same pipeline as a tap in the app.

Do I need to poll, or is there a webhook?

Today you poll GET /v1/generations/:id until status is completed or failed — see Quickstart for the full flow. There is no public webhook for API consumers yet; it's on the roadmap.

Can I pass my own hosted image URLs instead of using /v1/uploads?

Yes. Any publicly reachable image URL works anywhere an image field is accepted. POST /v1/uploads is a convenience for getting a hosted URL — it isn't a requirement if you already host your product images somewhere reachable.

What image formats and sizes are accepted?

JPEG, PNG, or WebP, up to 8 MB, when uploading via POST /v1/uploads. Self-hosted URLs you pass directly aren't limited by this cap, but keep them reasonably sized for faster generations.

How many API keys can I have?

Up to 5 active keys per account. Create and revoke keys from the dashboard under Profile → API Keys — see Authentication for how to use one.

What happens if a generation fails?

The diamonds charged for it are automatically refunded. Check the errorMessage field on the generation for why it failed — see Rate Limits & Errors for the full list of error codes and what they mean, or top up if the failure was credit-related on Pricing & Credits.

Which tool should I use to change a garment's background?

Depends on the result you want. For a clean, transparent cutout, use Remove Background. To put the garment on a model in a real scene instead, use Virtual Try-On.

Is there a sandbox / test mode?

No. There is no separate sandbox — every key is live, and every successful generation spends real diamonds. Test with a topped-up account; see Pricing & Credits for how to add credits.