Ready Player Me · JSON Structure

Ready Player Me Avatar Structure

Structural overview of the Ready Player Me Avatar object as exposed by /v2/avatars endpoints.

Type: object Properties: 0
Avatars3DGamingVRARMetaverseglTFCross-PlatformUnityUnrealWebMobile

Ready Player Me Avatar Structure is a JSON Structure definition published by Ready Player Me. It conforms to the https://json-structure.org/schema/v0 meta-schema.

Meta-schema: https://json-structure.org/schema/v0

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/schema/v0",
  "$id": "ready-player-me-avatar-structure.json",
  "title": "Ready Player Me Avatar — JSON Structure",
  "description": "Structural overview of the Ready Player Me Avatar object as exposed by /v2/avatars endpoints.",
  "type": "object",
  "fields": {
    "id": {
      "type": "string",
      "description": "Avatar identifier (24-character hex)."
    },
    "partner": {
      "type": "string",
      "description": "Studio application or partner that owns the avatar."
    },
    "userId": {
      "type": "string",
      "description": "Owner user identifier."
    },
    "bodyType": {
      "type": "enum",
      "values": ["halfbody", "fullbody"]
    },
    "gender": {
      "type": "enum",
      "values": ["masculine", "feminine", "neutral"]
    },
    "assets": {
      "type": "map",
      "keyDescription": "Asset category (hair, outfit, headwear, glasses, etc.)",
      "valueType": "string",
      "valueDescription": "Asset identifier."
    },
    "createdAt": {
      "type": "datetime",
      "format": "RFC 3339"
    },
    "updatedAt": {
      "type": "datetime",
      "format": "RFC 3339"
    }
  }
}