APIs at a glance
Two products, briefly
Section titled “Two products, briefly”This site documents the Skin Analysis and Product Recommendations APIs — both server-side, image- or data-in / JSON-out. For real-time webcam-based virtual try-on, use Revieve VTO — a separate browser-side product with its own face tracking. The split:
| You want… | Use |
|---|---|
| Per-metric skin analysis (wrinkles, redness, age, …) | Skin Analysis API (this site) |
| Catalog-aware product recommendations | Product Recommendations API |
| Real-time makeup try-on (lipstick, eyeshadow, full looks) | Revieve VTO |
| Hair-colour try-on | Revieve VTO / AI Hair Color Artist |
Skin Analysis API
Section titled “Skin Analysis API”A single POST /analyzeImage/ endpoint that accepts a multipart-encoded JPEG and a small set of query parameters. Returns a JSON document containing:
results— per-component findings (score, regional measurements, masks).face_area— bounding box and face rotation.status— informational, warning, and error codes describing image quality and per-metric outcomes.inverse_color_balance_rb— inverse white-balance factors[invR, invB, luminance]for re-applying the image’s colour cast to measured colours (see Interpreting results).
You ask for what you need via the components query parameter. Common picks:
| Use case | Components |
|---|---|
| Skin assessment | wrinkles, redness, hyperpigmentation, acne, pore_dilation, skin_age |
| Foundation shade match | makeup |
| Hair attribute readout | hair |
See the full reference at /api/skin-analysis/.
Product Recommendations API
Section titled “Product Recommendations API”Catalog-aware ranked recommendations. You provide partner taxonomy and optionally pass through analysis output and user preferences.
See the reference at /api/product-recommendations/.
When to call which
Section titled “When to call which”Capture image → Skin Analysis → render results → Product Recommendations using analysis output as input. This is the “expert consultation” pattern.
Use Revieve VTO. Real-time try-on is not built on the Skin Analysis API.
Capture image → Skin Analysis with makeup → read Skin foundation RGB, Skin undertone, Skin Fitzpatrick type from sum_measures[] → query Product Recommendations filtered by foundation taxonomy.
No image. Send only user preferences and inventory filters to Product Recommendations. Lighter integration, lower personalisation ceiling.
Hosting and environments
Section titled “Hosting and environments”| Environment | Base URL | When to use |
|---|---|---|
| Test | https://partner-test.revieve.com/api/3/ | Evaluation, integration, QA. Rate-limited. |
| Production | Region-specific (EU, US, Asia) | Provided with your production Partner ID. |
The Partner ID jmlv6b2qtS is wired up to test and is safe to commit.