Configuration Schema

JSON schema for rooomAvatars avatar settings used by URL parameters, config messages, and the REST API.

The rooomAvatars Editor uses a JSON settings object for the current avatar configuration. Use the same object in URL parameters, config messages, and the body of a POST /avatar request.

Overview

The top-level object has a required version field and optional sections such as body, head, hair, beard, cloth, and hat.

Fields

• version (string, required): currently "1.0.0"
• body (object, optional)
  • gender ("masculine" | "feminine")
  • skinColor (string, hex color)
• head (object, optional)
  • id (string)
  • eyeColor (string, hex color, optional)
• hair (object, optional)
  • id (string)
  • color (string, hex color, optional)
• beard (object, optional)
  • id (string)
  • color (string, hex color, optional)
• cloth (object, optional)
  • id (string)
  • coatColor, topColor, pantsColor, shoesColor (string, optional)
• hat (object, optional)
  • id (string)

Example

Use placeholder asset IDs until you replace them with IDs from your editor integration:

{
  "version": "1.0.0",
  "body": { "gender": "feminine", "skinColor": "#c58c85" },
  "head": { "id": "HEAD_ASSET_ID", "eyeColor": "#6b8e6b" },
  "hair": { "id": "HAIR_ASSET_ID", "color": "#8B4513" },
  "cloth": { "id": "CLOTH_ASSET_ID" }
}

Replace HEAD_ASSET_ID, HAIR_ASSET_ID, and CLOTH_ASSET_ID with asset IDs available to your integration.