Ready Player Me Avatars API
Create, retrieve, update, and delete Ready Player Me cross-platform avatars. Includes template-based creation, asset equipping, draft management, color palette discovery, and binary glTF (.glb) plus 2D PNG renders used in Unity, Unreal, web, iOS, and Android. Supports A/T-pose, mesh LODs, texture atlases, ARKit / Oculus morph targets, Draco and Meshopt compression.
Ready Player Me Avatars API is one of 3 APIs that Ready Player Me publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Avatars, 3D, GLB, and Gaming. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.
This API exposes 14 operations across 11 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against a single base URL, https://api.readyplayer.me.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Ready Player Me Avatars API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-APP-ID (AppId).
By default, every request must be authenticated.
Paths & Operations 14
Across 11 paths, the API surfaces 14 operations — 2 DELETE, 7 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Avatar creation, asset equipping, render, and lifecycle operations.
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Avatar (6 properties), AvatarTemplate (3 properties), AvatarCreateRequest (1 property), AvatarUpdateRequest (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Ready Player Me 2
Other APIs Ready Player Me publishes across the network.