GET - 2D Render of an Avatar

Get a 2D render of an avatar for stickers or profile pictures.

All avatars are hosted in a CDN under https://models.readyplayer.me.

Please always use the https://models.readyplayer.me URL for Avatar requests instead of https://api.readyplayer.me/.

Get avatar 2D render by id.

GET https://models.readyplayer.me

Get an avatar 2D image with desired settings.

Path Parameters

NameTypeDescription

avatarId.(png|jpg)*

String

ID of an avatar.

Query Parameters

NameTypeDescription

blendShapes

String

Map of 3D meshes to their blend shapes.

cacheControl

Boolean

Uses custom Cache-Control header

uat

String

User Avatar Timestamp

size

Number

Image width and height

quality

Number

Image compression quality

camera

String

Camera preset

background

String

Background color value

expression

String

Avatar facial expression

pose

String

Avatars pose

Parameters, expected values, and examples

ID of an avatar with .png or .jpg file extension.

Expected values (String)

  • 64e3055495439dfcf3f0b665.png

  • 64e3055495439dfcf3f0b665.jpg

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.

Specify which facial expression the Avatar will be making.

Expressions can also be combined together with poses and blend shapes for more advanced use-cases.

Expected values (String)

  • happy

  • lol

  • sad

  • scared

  • rage

Specify which pose the Avatar will take for the image.

Poses can also be combined together with expressions for more advanced use-cases.

Expected values (String)

  • power-stance

  • relaxed

  • standing

  • thumbs-up

Map of 3D meshes to their blend shapes.

Expected values (String) blendShapes[mouthSmile]=0.2

  • 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[mouthSmile]=0.2&blendShapes[browInnerUp]=0.2

Specify which camera preset should be used for the image.

Expected values (String)

  • portrait - this is the default camera.

  • fullbody

  • fit

Control the background color in RGB format. Expected values (String)

  • 255,255,255 - red, green, blue

Defines the compression quality for lossy formats like jpg. Default quality is highest.

Expected values (Number)

  • min 0

  • max 100

Higher number means higher image quality.

Specify image dimensions for width and height in pixels.

Expected values (Number)

  • min 1

  • max 1024

The User Avatar Timestamp (UAT) parameter allows users to set and retrieve the last modified timestamp of their avatars using the ".json" endpoint. It ensures efficient avatar synchronization, minimizing server requests, and delivering real-time updates to avatars for an enhanced user experience and seamless integration with our partners. By default we use no-cache meaning user will go to our CDN and get a cached version (you don't get the benefit of browser disk storage) Expected values (String)

  • 2023-07-05T10:39:48.911Z

Last updated