Manage custom outfits using the API
Create UGC tools or embed Ready Player Me in your content pipeline.
Last updated
Create UGC tools or embed Ready Player Me in your content pipeline.
Last updated
This page will be in a different section, once released, which currently does not exist. so this place is just temporary.
You can embed the outfit management into your pipeline using the Assets endpoints of the Ready Player Me API. It also enables you to create tools to create UGC tools on top of the APIs.
An "asset" can be seen as the meta-data of an asset model. Therefore it contains a name, type, gender, URLs for the 3D-model and the icon, etc. but not the asset itself.
POST https://api.readyplayer.me/v1/assets
| Name | Type | Description |
|---|---|---|
To create an asset, the URL of a 3D model and an icon is optional. You can update it later or upload a Model / Icon using the respective POST commands (Upload Model, Upload Asset).
If you specify a model URL, it will trigger the validation of the model. Please check out all details about the validation in the 3D asset creation guide. In case of a negative validation, you will be returned the validation errors in the response, and the asset will not be created.
If you specify an icon URL, it will check its max dimensions of 256x256 and max file size of 5MB. In case of a negative validation, you will be returned the validation errors in the response, and the asset will not be created.
Once an asset is created and has a valid model and icon, it can be added to an application. By default, an asset does not belong to any application and therefore is also not visible in the avatar creator.
An Icon is needed to show the asset in the avatar-creator for the end user.
You can either use the URL parameter in the Create Asset command to upload an Icon, or use the POST to upload the image itself. Therefore the asset needs to exist already.
POST https://api.readyplayer.me/v1/assets/:id/icon
This endpoint requires the body to be of type form-data, and to have a Content-Type of multipart/form-data.
Recommended Specs: .png or .jpg with a dimension of 256x256 pixel max. The image may not exceed 5MB. However, for the best loading speed of the avatar creator, you should optimize the image size.
You need to have a Ready Player Me compatible full-body outfit. You can learn how to create one from a template in the Asset Creation Guideline.
You can use the URL parameter in the Create Asset command to upload a 3D model or the POST to upload the model itself separately. For the second approach, the asset needs to exist already.
Once the model is uploaded, it will trigger the validation of the model. Please check out all details about the validation in the 3D asset creation guide. In case of a negative validation, you will be returned the validation errors in the response, and the asset will not be created.
POST https://api.readyplayer.me/v1/assets/:id/model
This endpoint requires the body to be of type form-data, and to have a Content-Type of multipart/form-data.
In Studio (Developer Dashboard) you need to create an Application for every game or app you create. Each application has an Application ID, which you can find in the URL of the page.
After you obtained the Application ID you can make a POST request to the following endpoint:
POST https://api.readyplayer.me/v1/assets/:id/application
After getting the success-message, you should be able to see your custom asset in your avatar creator https://[yoursubdomain].readyplayer.me.
When you no longer want to have the asset available in your avatar creator, you can remove it from the application.
DELETE https://api.readyplayer.me/v1/assets/:id/application
You can retrieve a paginated, ordered list of all uploaded assets in your organization.
GET https://api.readyplayer.me/v1/assets
Use this endpoint to fetch a paginated list of assets. With query parameters, you control the order, the number of assets you want per page, and the selected page.
Currently, it is not possible to apply any filters to the request. So you need to fetch the list and query it on your end.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
data.name*
string
Minimum length of 1 character
data.organizationId*
string
The id of the organization you wish to create the asset under. This is directly linked to your permissions, and you will only be able to create assets for organizations which you have permission to.
data.iconUrl*
url
Must be a valid url pointing to a PNG or JPG file.
data.modelUrl*
url
Must be a valid url pointing to a GLB file.
data.gender*
enum(string)
Possible values: male, female
data.type*
enum(string)
Possible values: outfit
data.applicationIds
array
List of application ids, this asset should be added to. If empty, this asset is not added to any application.
Content-Type*
multipart/form-data
file*
file
The icon file to upload (PNG orJPG)
Content-Type*
multipart/form-data
file*
file
Must be a valid GLB file.
id*
string
The id of the asset you want to update.
data.applicationId*
string
The id of the application you wish to add the asset to.
id*
string
The id of the asset you want to update.
data.applicationId*
string
The id of the application you wish to remove the asset from.
order
string
The properties you would like to order the list by. You can specify multiple properties by adding the query param multiple times. Please check the example-response to check the names.
limit
number
The amount of documents you want to fetch per page.
page
number
The page of documents you would like to fetch.
