Getting started
The Catalog Pro API lets your app make product photos and clothing photos worn by a model. Your server sends us photos, and a couple of minutes later you collect the finished photos.
Base URL
Every request goes to this address, followed by the path of the API you want.
https://us-central1-aiavatar-01.cloudfunctions.net/businessApiYour API key
Send your key in a header called X-Api-Key on every request. You'll find the key in your dashboard, under API key.
X-Api-Key: cp_live_xxxxxxxxxxxxxxxxOnly call the API from your own backend. Never put the key in a mobile app, a web page or public code — anyone who has it can use up your photos, and we can't be responsible for a key that has been exposed. If it leaks, rotate it in your dashboard.
How it works
- Set up your business in the dashboard and buy a plan of photos.
- Create your models in the dashboard. These are the people who will wear your clothing.
- Send a request from your server. You get a
job_idback straight away. - Check the result a couple of minutes later using that
job_id, then save the photos on your side.
All the APIs
| API | What it does |
|---|---|
GET /models | Lists the models you created, so your users can pick one. |
POST /products | Makes photos of a product on a plain white background. |
POST /clothing | Makes photos of a garment worn by one of your models. |
GET /jobs/{job_id} | Tells you if the photos are ready, and gives you their links. |
GET /jobs | Lists your recent requests, optionally for one user. |
Three things to remember
Don't keep your user waiting on a loading screen. Save the job_id and check back once every 15 seconds — not in a loop.
We delete photos 30 days after they're made. Download them to your own storage as soon as they're ready.
Each of your users can have one request running. Up to 50 of your users can make photos at the same time.