REST API

Register an avatar configuration and download the resulting model file using the rooomAvatars REST API.

The rooomAvatars REST API allows you to register avatar configurations and download the resulting 3D models and preview images.

Overview

The rooomAvatars REST API is used to:

• Register an avatar configuration and receive an avatarId.
• Download the generated model by avatarId.

Prerequisites

• An API base URL for your environment.
• An API token for the Authorization: Bearer ... header.

Steps

1. Use a bearer token to authenticate requests to POST /avatar.
2. Use the returned modelId as your avatarId.
3. Download the model via GET /model/:avatarId.

Examples

• Authentication
• Endpoints