rooomAvatars Overview

Create and export user avatars with the rooomAvatars Configurator and REST API.

Embed a web-based avatar configurator in your application and export the result as a downloadable 3D model. You integrate the configurator via an iframe and communicate with it using postMessage.

Overview

The rooomAvatars stack consists of:

• Editor (Web UI): an embeddable UI to edit an avatar.
• REST API: endpoints to register the final avatar settings and download a model file.

Steps

1. Open the Editor embedding guide to review embedding instructions.
2. Embed the configurator as an iframe with the API token in the URL hash.
3. Listen for the rooom-avatars-completed message to receive the avatar ID and model URL.
4. Download the model with the REST API.

Examples

• URL Parameters
• Iframe Messaging
• Configuration Schema

Tutorials

• Playing Built-in Animations
• Using Mixamo Animations

Troubleshooting

If the configurator does not initialize or the API returns authorization errors, see:

• Troubleshooting