Avatars

Get an avatar

Requires an API key with the avatars:read scope.

get/v1/avatars/{avatarId}

Request

  • Base URL: https://realtimeavatar.ai/api
  • URL: https://realtimeavatar.ai/api/v1/avatars/{avatarId}
  • Auth: HTTP bearer

Path parameters

avatarIdstring required

Response

Avatar

idstring required
tenantIdstring required
displayNamestring required
sourceKind'image' | 'video' required
modelId'realtime-avatar-live-v1' | 'realtime-avatar-video-v1' required
sourceAssetIdstring nullable required
status'draft' | 'preprocessing' | 'ready' | 'failed' | 'disabled' | 'deleted' required
errorstring nullable required
idleVideoStatus'none' | 'queued' | 'generating' | 'ready' | 'failed' required
defaultVoiceIdstring nullable required
createdAtstring required
updatedAtstring required

Changes

No recorded changes to this operation across all 2 revisions of this API.