Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ready Player Me Auth API

Anonymous user creation, email-code login, token refresh, and avatar access tokens used by the Ready Player Me Avatar Creator and SDKs. Authentication runs through each application's per-studio subdomain.

Ready Player Me Auth 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 Authentication, Identity, and Users. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 5 operations across 5 paths, and defines 2 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.

5 operations 5 paths 2 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.readyplayer.me/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ready Player Me Auth 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 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Auth 5

User authentication and token management.

POST
/api/users
Create Anonymous User
createAnonymousUser → 201
POST
/api/auth/start
Start Login With Email Code
authStart body → 200
POST
/api/auth/login
Confirm Login Code
authLogin body → 200
POST
/api/auth/refresh
Refresh Auth Tokens
authRefresh body → 200
POST
/v1/auth/token
Get Avatar Token
getAvatarToken body → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are User (4 properties), AuthTokens (2 properties). Each schema is shown below with its type and property counts.

User
object
4 properties
AuthTokens
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ready-player-me-auth-api-openapi.yml Raw ↑

Other APIs Ready Player Me publishes across the network.

Ready Player Me Avatars API
Ready Player Me Assets API