Ready Player Me

Ready Player Me Assets API

Discover and retrieve avatar wearable assets — hair, outfits, headwear, glasses, facewear, footwear, beards, costumes, and custom assets — scoped to an application and optionally filtered to those viewable or usable by a specific user. Powers the wardrobe surface of the Ready Player Me Avatar Creator.

Ready Player Me Assets API is one of 3 APIs that Ready Player Me publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 machine-runnable capability that can be deployed as REST, MCP, or Agent Skill surfaces via Naftiko.

Tagged areas include Assets, Wearables, 3D, and Gaming. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 Naftiko capability spec.

Documentation GitHub OpenAPI

OpenAPI Specification

openapi: 3.0.3
info:
  title: Ready Player Me Assets API
  description: |
    List, filter, and retrieve Ready Player Me assets — hair, outfits, headwear,
    glasses, facewear, footwear, beards, costumes, and custom assets — that can be
    equipped on avatars. Assets are scoped to an application (`X-APP-ID`) and can be
    further filtered to those visible or usable by a specific user.
  version: "1.0"
  contact:
    name: Ready Player Me Developers
    url: https://docs.readyplayer.me/
servers:
  - url: https://api.readyplayer.me
    description: Production
security:
  - AppId: []
paths:
  /v1/assets:
    get:
      summary: List Assets
      operationId: listAssets
      tags:
        - Assets
      parameters:
        - name: type
          in: query
          schema:
            type: string
            enum:
              - hair
              - beard
              - outfit
              - shirt
              - top
              - bottom
              - footwear
              - headwear
              - facewear
              - glasses
              - costume
              - custom
              - baseModel
        - name: limit
          in: query
          schema:
            type: integer
            default: 16
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: gender
          in: query
          schema:
            type: string
            enum: [masculine, feminine, neutral]
        - name: filter
          in: query
          schema:
            type: string
            enum:
              - viewable-by-user-and-app
              - usable-by-user-and-app
        - name: filterApplicationId
          in: query
          schema:
            type: string
        - name: filterUserId
          in: query
          schema:
            type: string
      responses:
        '200':
          description: A paginated list of assets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetList'
  /v1/assets/{assetId}.glb:
    get:
      summary: Get Asset GLB Model
      operationId: getAssetGlb
      tags:
        - Assets
      parameters:
        - $ref: '#/components/parameters/AssetId'
      responses:
        '200':
          description: Binary glTF asset model.
          content:
            model/gltf-binary:
              schema:
                type: string
                format: binary
  /v1/assets/{assetId}/thumbnail.png:
    get:
      summary: Get Asset Thumbnail
      operationId: getAssetThumbnail
      tags:
        - Assets
      parameters:
        - $ref: '#/components/parameters/AssetId'
      responses:
        '200':
          description: Thumbnail image.
          content:
            image/png:
              schema:
                type: string
                format: binary
  /v1/phoenix-assets:
    get:
      summary: List Phoenix Assets
      operationId: listPhoenixAssets
      tags:
        - Assets
      description: List base-model and phoenix-tier assets for an application.
      parameters:
        - name: applicationId
          in: query
          required: true
          schema:
            type: string
        - name: type
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Phoenix asset list.
components:
  securitySchemes:
    AppId:
      type: apiKey
      in: header
      name: X-APP-ID
  parameters:
    AssetId:
      name: assetId
      in: path
      required: true
      schema:
        type: string
  schemas:
    Asset:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
        gender:
          type: string
        iconUrl:
          type: string
        modelUrl:
          type: string
        applicationIds:
          type: array
          items:
            type: string
    AssetList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Asset'
        pagination:
          type: object
          properties:
            page:
              type: integer
            limit:
              type: integer
            totalPages:
              type: integer
            totalDocs:
              type: integer
tags:
  - name: Assets
    description: Asset discovery, filtering, and retrieval.

Ready Player Me Assets API

Documentation

Specifications

Other Resources

OpenAPI Specification