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

Name	Type	Description
avatarId.png*	String	ID of an avatar.

Query Parameters

Name	Type	Description
scene	String	Name of portrait type to render.
blendShapes	String	Map of 3D meshes to their blend shapes.

200: OK 2D Render of the avatar.

404: Not Found The requested avatar is not available.

{
    // Response
}

Parameters, expected values, and examples

/avatarId.png

ID of an avatar with .png file extension.

Expected values (String)

• 6185a4acfb622cf1cdc49348.png

It may take some time to render the image in the backend for the initial request. For subsequent requests, the images will be fetched from cache and delivered much faster.

Example

Request avatar render by ID.

https://models.readyplayer.me/6185a4acfb622cf1cdc49348.png

Returned value

You will receive a .png image.

?scene

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.

Example

Request avatar render with transparent fullbody posture

https://models.readyplayer.me/6185a4acfb622cf1cdc49348.png?scene=fullbody-posture-v1-transparent

Request avatar render for full body portrait on dark background

https://models.readyplayer.me/6185a4acfb622cf1cdc49348.png?scene=fullbody-portrait-v1

?blendShapes

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.

You can combine multiple blend shapes by concatenating them with '&' as shown in the following example:

?blendShapes[Wolf3D_Head][mouthSmile]=0.2&blendShapes[Wolf3D_Head][browInnerUp]=0.2

Example

Request a smiling avatar

https://models.readyplayer.me/6185a4acfb622cf1cdc49348.png?blendShapes[Wolf3D_Head][mouthSmile]=0.8

Returned value

You will receive a .png image of a smiling avatar.