GET - 2D Avatars
Get a 2D render of an avatar for stickers or profile pictures.
Get avatar 2D render by id.
GET
https://models.readyplayer.me
Get an avatar 2D image with desired settings.
Path Parameters
avatarId.png*
String
ID of an avatar.
Query Parameters
scene
String
Name of portrait type to render.
blendShapes
String
Map of 3D meshes to their blend shapes.
Parameters, expected values, and examples
ID of an avatar with .png file extension.
Expected values (String)
6185a4acfb622cf1cdc49348.png
Name of the portrait type to render.
Expected values (String)
fullbody-portrait-v1
- Creates a portrait from a full-body avatar...fullbody-portrait-v1-transparent
- ... with transparent background (default).halfbody-portrait-v1
- Creates a portrait from a half-body avatar...halfbody-portrait-v1-transparent
- ... with transparent background (default).fullbody-posture-v1-transparent
- Creates a portrait with a pose from a full-body avatar.
Map of 3D meshes to their blend shapes.
Expected values (String)
blendShapes[Wolf3D_Head][mouthSmile]=0.2 }
Wolf3D_Head
is the affected node in the avatar.mouthSmile
is an example of a blend shape included in the avatar.
You can find all available blend shapes in Full-body Avatars.
Last updated
Was this helpful?