Get Customization

Get current avatar customization.

Customization is the combination of applied assets (clothes, hairstyles, accessories etc), as well as the body type and other parameters (age, eyes color, skin tone correction and bones scale).

NOTE: Behavior of this endpoint for avatars created by direct photo upload and not yet opened via browser UNDEFINED and can be changed in the future. Set customization via corresponding endpoint to get predictable behaviour.

get/api/v1/avatars/{id}/customization

Request

  • Base URL: https://api.avaturn.me
  • URL: https://api.avaturn.me/api/v1/avatars/{id}/customization
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Response

Successful Response

body'body_0' | 'body_1' | 'body_2' | 'body_3' | 'body_4' required
age'3-6' | '7-12' | '13-16' | 'adult'
metadataobject

Arbitrary key-value pairs. Use them to store any data associated with avatar. 10 pairs max, 50 chars max key length, 500 chars max value length

skin_tone_correctionnumber
eye_texture'light_green' | 'amber' | 'blue' | 'blue_gray_yellow' | 'brown' | 'dark_brown' | 'gray' | 'gray_green' | 'green' | 'light_gray'

Example response

{
  "assets": {
    "hair_and_headwear": {
      "color": "#aabbcc"
    },
    "eyewear": {
      "color": "#aabbccaa"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.