REST API
Last updated
Last updated
All API access is sent over HTTPS and accessed from https://api.readyplayer.me.
To enable straightforward integration of Ready Player Me avatars, the GET avatar endpoints are publicly available and currently do not require authentication.
All other Endpoints require an API Key in the Header X-API-Key, that can be generated in Studio.
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.
Timestamps return in UTC time.
| Status Code | Description |
|---|---|
All 3D avatars are delivered in GLB format.
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.
GLB is a compressed binary version of a (JSON-based) GLTF file and includes all of the elements that comprise a 3D avatar model, such as materials, meshes, node hierarchy, and cameras. GLB files are compact, represent complete scenes, and load fast. You can read more about GLB and glTF in the documentation.
Download a demo full-body avatar .glb and open it in any 3D viewer or app to see the details.
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 permission 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.