Ask or search…
K
Links

Manage custom outfits using the API

Create UGC tools or embed Ready Player Me in your content pipeline.
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.

Get and authorize with an API Key

For all subsequent requests to the Asset endpoints, you need an API Key. Please go to Studio -> API Keys to create one.
You can authorize by adding x-api-key to the header of the request.
--header 'x-api-key: {your-api-key}'

Upload a custom outfit

1. Create the asset meta-data.

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
Use this endpoint to create a new asset
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.

2. Upload or Update an Icon

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
Use this endpoint to upload the icon for an asset
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.

3. Upload or Update the 3D Model

You need to have a Ready Player Me compatible full-body outfit. You can learn how to create one in this guide here.
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
Use this endpoint to upload the model for an asset

4. Add an asset to an application

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 obtain the Application ID, you can make a POST request to the following endpoint:
post
https://api.readyplayer.me/v1
/assets/:id/application
Use this endpoint to add an asset to an application
After getting the success message, you should be able to see your custom asset in your avatar creator https://[yoursubdomain].readyplayer.me.

5. Remove the asset from the application

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
Use this endpoint to remove an asset from an application

6. Get all custom assets

You can retrieve a paginated, ordered list of all uploaded assets in your organization.
get
https://api.readyplayer.me/v1
/assets
List Assets

Full API Reference

To see example requests, please check out the REST API Reference