Skip to navigation
Getting started

Build with MorphiaOne

Skin, makeup, and hair imaging over one asynchronous API.

MorphiaOne lets your server analyze a face image, apply makeup, or recolor hair under a mask you provide. The same API supports three integration paths. Start with an SDK unless your language or deployment needs direct HTTP calls.

Release status. API 1.0.0-rc.1 is a release candidate: request and response shapes may still change before the stable release. SDK 0.2.2 is published as a Developer Preview (@morphiaone/sdk on npm and morphiaone on PyPI).

Start here

  1. Get access. Accounts are provisioned by MorphiaOne; once invited, sign in at platform.morphiaone.ai and create an API key.
  2. Pick a path below and send your first request to https://api.morphiaone.ai, with a pk_test_ key while you build.
  3. Read the production guide before you go live.

Accounts, environments and keys

TermWhat it is
AccountYour organization: its members, billing and credits.
Environmentlive or test. Every account has one of each. Keys, Assets, Jobs, usage and webhook endpoints belong to one environment and never cross into the other.
API keyA server-side secret for one environment: pk_live_... or pk_test_.... It carries the scopes of the products it may call.

Choose an integration path

TypeScript
Developer Preview

npm install --save-exact @morphiaone/sdk@0.2.2

Node.js 20 or newer. Typed, ESM, no runtime dependencies.

Python
Developer Preview

python -m pip install morphiaone==0.2.2

Python 3.11 or newer, with a sync and an async client.

REST
Release candidate

https://api.morphiaone.ai

Plain HTTP with an X-API-Key header, from any language.

The SDKs handle authentication headers, Asset uploads, idempotency keys, retries, job polling, and typed results. Use REST when you need a direct HTTP integration or want to implement those steps yourself. Both SDKs are server-side packages; an API key must never ship in a browser or mobile app.

One request pattern across products

  1. Upload each input image once as an Asset.
  2. Submit a product request that references its Asset id. The API returns a Job and runs the work asynchronously.
  3. Wait for the Job to finish, then read its typed output and any result Assets.

A successful submission means the Job was accepted. It does not mean the analysis or render succeeded. A failed Job is terminal and carries a code; handle it before reading output. See Jobs, Errors, and Idempotency.

Products and availability

Skin Analysis returns cosmetic scores and optional visualizations. Makeup Try-On renders requested products in order. Hair Color Try-On finds the hair in a photo and recolors it; it does not change style or length.

The product availability table is the shared status source for this site and the Developer Platform. Your account is provisioned for the products in your agreement, and a key calls a product only if it carries that product’s scope.

From first request to production

Start with the TypeScript quickstart. For Python, begin with the Python SDK guide. If a browser or mobile application needs results, put a backend-for-frontend between the client and MorphiaOne; see serving a browser or mobile client.

Before launch, read Going to production and error handling guide. The endpoint reference is generated from the API contract, while these guides explain integration choices and failure handling.