v1

latestOpenAPI 3.0.32026-07-24106305257.4 KB
V4 Avatars

Get avatar by id

get/expressives/avatars/{id}

Path parameters

idstring required

Response

OK

idstring required

The id of the avatar

owner_idstring required

The id of the owner of the avatar

namestring required

The name of the avatar

is_greenscreenboolean required

Whether the avatar is a greenscreen avatar

thumbnail_urlstring

The thumbnail url of the avatar

genderstring

The gender of the avatar

Example response

{
  "name": "John Doe",
  "sentiments": [
    {
      "sentiment": "happy",
      "description": "An enthusiastic, expressive avatar full of charm and personality.”",
      "voice": {
        "voice_id": "en-US-JennyNeural",
        "voice_config": {
          "rate": "0.5",
          "pitch": "+2st"
        },
        "language": "English (United States)"
      }
    }
  ]
}