Links

Overview

Ready Player Me provides an API layer to retrieve Ready Player Me 3D and 2D avatars along with their metadata.
You are working with Unity or Unreal Engine? Most features of the Avatar API are available directly from the SDK.

General

  • The Avatar API is organized around REST.
  • The API returns standardized .glb or .png files for the 3D and 2D avatars or JSON-encoded responses. Only default HTTP response codes are used.
  • All API access is sent over HTTPS and accessed from https://api.readyplayer.me
  • Timestamps return in UTC time.

Authentication

To enable straightforward integration of Ready Player Me avatars, most endpoints are publicly available and currently do not require authentication.
Partner level APIs and specific endpoints, once available, will have more restricted access.

Errors

The Avatar API uses conventional HTTP response codes to indicate the success or failure of an API request.
  • Codes in the 2xx range indicate success.
  • Codes in the 4xx range indicate a failure given the information provided.
  • Codes in the 5xx range indicate an error with Ready Player Me services.
Status Code
Description
200 - OK
Everything worked as expected.
400 - Bad Request
The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized
Unauthorized request for a secured endpoint
402 - Request Failed
The parameters were valid but the request failed.
403 - Forbidden
The authorized user doesn't have permissions to perform the request.
404 - Not Found
The requested resource doesn't exist.
5xx - Server Errors
Something went wrong on Ready Player Me’s end.