Submit a cosmetic Skin analysis Job

curl -X POST https://api.morphiaone.ai/v1/skin/analyses \
     -H "X-API-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "concerns": [
    "acne"
  ],
  "inputs": [
    {
      "asset_id": "string",
      "role": "string"
    }
  ]
}'

{
  "completed_at": "2024-01-15T09:30:00Z",
  "created_at": "2024-01-15T09:30:00Z",
  "error": {
    "code": "INPUT_UNPROCESSABLE",
    "message": "string"
  },
  "expires_at": "2024-01-15T09:30:00Z",
  "id": "string",
  "inputs": [
    {
      "asset_id": "string",
      "role": "string"
    }
  ],
  "operation": "makeup.apply",
  "output": {
    "type": "makeup.try_on",
    "image": {
      "expires_at": "2024-01-15T09:30:00Z",
      "href": "string",
      "id": "string",
      "media_type": "image/png",
      "role": "string",
      "size_bytes": 1,
      "height": 1,
      "width": 1
    },
    "revision": 1
  },
  "status": "queued",
  "updated_at": "2024-01-15T09:30:00Z",
  "livemode": true
}

Typed JSON request referencing one uploaded input asset. concerns is required and is a set: order does not matter and a duplicate is a 400. Only the requested concerns are analysed. Cosmetic appearance analysis, not a clinical diagnosis. Idempotency semantics as for makeup_try_ons_create.

Authentication

X-API-Keystring

API key for one environment of your account. Keep server-side; never expose in browser clients.

Request

This endpoint expects an object.

concernslist of enumsRequired

inputslist of objectsRequired

visualizationslist of objectsOptionalDefaults to []

Response headers

Cache-ControlstringOptional

API responses are private to the caller and not cacheable

Idempotency-ReplayedenumOptional

True when this response reuses an existing job

Allowed values:

LocationstringOptional

Relative URL of the created or replayed job

RateLimitstringOptional

The state of each policy in RateLimit-Policy: "submit";r=59;t=1, r remaining and t seconds until whole again.

RateLimit-LimitintegerOptional

Quota of the most restrictive policy (draft-07 form).

RateLimit-PolicystringOptional

The limits this request consumed, as an RFC 8941 list (draft-ietf-httpapi-ratelimit-headers): "submit";q=60;w=60. Policies are submit, upload and daily. Sent only while rate-limit headers are on.

RateLimit-RemainingintegerOptional

Remaining quota of the most restrictive policy (draft-07 form).

RateLimit-ResetintegerOptional

Seconds until the most restrictive policy is whole again.

Retry-AfterstringOptional

Delay before retrying, expressed as delta-seconds

X-Request-IdstringOptional

Request correlation identifier

Response

Idempotent replay of the job the first submission created

completed_atdatetime or null

created_atdatetime

errorobject or null

expires_atdatetime or null

idstring

inputslist of objects

operationenum

What a job does: the operation’s authorization scope.

An operation is not its output’s type: OPERATION_OUTPUT_TYPE is the one place the two meet.

Allowed values:

outputobject or null

statusenum

Allowed values:

updated_atdatetime

livemodebooleanOptional

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

410

Gone Error

413

Content Too Large Error

429

Too Many Requests Error

503

Service Unavailable Error

Authentication

Headers

Request

Response headers

Response

Errors