Sign in

v1

latestOpenAPI 3.0.32026-07-13142734.3 KB
avatar3d

Get a 3D avatar GLB file

Get a 3D avatar GLB model with desired performance and configuration settings

get/avatars/{avatarId}/3d

Path parameters

avatarIdstring required
Example:65a8dba831b23abb4f401bae.glb

ID of an avatar

Query parameters

quality'low' | 'medium' | 'high'

Quality preset for 3D avatars

Use quality presets to combine performance related parameters

textureSizeLimitinteger
Example:512

Sets the upper limit for texture resolution in pixels of any texture in the avatar

textureQuality'low' | 'medium' | 'high'

Quality preset for 3D avatars

Set the quality for textures on the Avatar by choosing from one of the presets

textureAtlas'none' | '256' | '512' | '1024'

Texture atlas resolution

Generates a texture atlas of the desired resolution. The operation merges all meshes and splits opaque objects from transparent ones resulting in a maximum of 2 draw calls

textureChannelsstring
Example:baseColor,normal

Define which textureChannels should be included in the .glb. It can be a comma-separated combination of values

morphTargetsstring
Example:mouthSmile,ARKit

Comma-separated list of individual morph targets or morph target standard groups to include on the avatar

useDracoMeshCompressionboolean
Example:true

Reduces file size by compressing output avatars with Draco mesh compression. More effective on complex meshes

useQuantizeMeshOptCompressionboolean
Example:true

Reduces file size by quantizing vertex attributes and compressing output avatars with Mesh Optimization compression. More effective on meshes with morph targets

pose'A' | 'T'

Pose for full-body avatar

Defines the pose for a full-body avatar

useHandsboolean
Example:true

Toggles hands for half-body VR avatars

  • 'Include hands with half-body VR avatars (default)'
  • 'Do not include hands with half-body VR avatars'
textureFormat'webp' | 'jpeg' | 'png'

Texture format for avatars

Reduce avatar file size by formatting all textures into the specified format

lodinteger
Example:2

Control the triangle count of the entire avatar

  • 'No triangle count reduction (default)'
  • 'Retain 50% of the original triangle count'
  • 'Retain 25% of the original triangle count'

Response

OK