Create Avatar & Render

Tutorial on how to use the API to create an avatar and render a preview.

1. Authenticate

2. Create Avatar

3. Resolve Rendering

1. Authenticate

Select the appropriate oauth2 authentication flow for your use case and obtain an API access token. See Authentication for details.

For sake of simplicity of this example, you can use your application's client credentials to authenticate directly using the oauth2 resource owner flow. Returns an access token on success.

If you use other authentication flows, make sure to enable scopes read:avatars write:avatars read:renderings write:renderings.

curl --request POST \
  --url 'https://auth.loomai.com/oauth/token' \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data grant_type=http://auth0.com/oauth/grant-type/password-realm \
  --data realm=Username-Password-Authentication \
  --data username={PASSWORD} \
  --data password={USERNAME} \
  --data audience=https%3A%2F%2Fapi.loomai.com%2F \
  --data client_id={CLIENT_ID} \
  --data client_secret={CLIENT_SECRET}

2. Create Avatar

Post a photo of a face to create an avatar. Returns response header X-Loom-Status containing the id of created avatar if successful. See Avatars > Create for details.

curl -X POST "https://api.loomai.com/v0.5/avatars" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "Content-Type: multipart/form-data" \
  -F "image=@{IMAGE_FILE};type=image/jpeg"

3. Resolve Rendering

A rendered preview of created avatar is automatically created and can be resolved using the avatar ID. See Avatars > Attachments > List for details.

{
  "entries": [
    {
      "id": 5754466256551936,
      "type": "renderings_preview",
      "name": "neutral",
      "url": "https://storage.googleapis.com/live-com-loomai-api-attachments/5484235973984256/MThVY01uV2tfbWlhLWF2YXRhcg==.png",
      "updated_at": "2020-04-05T16:37:57Z"
    }
    ...
  ]
}

This returns a list of attachments - including uploaded photo, rendered preview (type renderings_preview) etc.