Quickstart
This step-by-step guide is designed to assist game developers in setting up player accounts and generating avatars through API integration.
Last updated
This step-by-step guide is designed to assist game developers in setting up player accounts and generating avatars through API integration.
Last updated
You will need to know your application subdomain. This is accessible from the studio on your application page. If you don't have an account in the studio, then you will need to sign up.
Account creation: Enable users to effortlessly create their accounts within your application.
Apply an existing template to the user: Facilitate users in customizing their avatars by applying pre-existing templates to their avatars for quick personalization.
Get user model: Fetch the created model into your application
All of the requests shown in this section are also visible in the public Ready Player Me Postman collection
In this guide, we'll walk you through the process of creating an anonymous user and obtaining the access token required to access the API endpoints. The following endpoint will create a new user and it returns the access token to use for the creation of an avatar.
POST
https://[your-application-subdomain].readyplayer.me/api/users
To create and render an initial avatar for your user, you need to call 3 endpoints.
Firstly you need to fetch all of the possible templates that you can create an avatar from. Templates are pre-configured avatar templates which make it easier for you to create an avatar via the API. To fetch the avatar templates you can call the following endpoint authenticated with the token returned on the request from step 1.
GET
https://api.readyplayer.me/v2/avatars/templates
Authorization*
Bearer [token]
Once you have made a call to fetch the list of templates, you can then take one of the template IDs and make a call to create a draft avatar for the user by calling the following endpoint.
POST
https://api.readyplayer.me/v2/avatars/templates/[template-id]
Authorization*
Bearer [token]
partner*
String
Application subdomain
bodyType*
fullbody
Avatar type
After making the call to create your new draft avatar, you can then fetch this avatar as a GLB by calling the following URL with your new avatar-id.
GET
https://api.readyplayer.me/v2/avatars/[avatar-id].glb?preview=true
The previous steps created a draft avatar for the user, which will expire after x amount of time. To save the avatar and permanently save it for the user, you will need to save the avatar with the following endpoint:
PUT
https://api.readyplayer.me/v2/avatars/[avatar-id]
Authorization*
Bearer [token]
You can now fetch your newly saved avatar from the URL below with the avatar id.
GET
https://models.readyplayer.me/[avatar-id].glb
You now have a working example with Ready Player Me avatars. You can go now into the next section, which explains how to customize your character with outfits.