Avatar Profiles

Get avatar

Return one AI Avatar, including processing status and reference URLs when available.

get/avatar-profiles/{id}

Request

  • Base URL
    https://api.mosaic.so
  • URL
    https://api.mosaic.so/avatar-profiles/{id}
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Path parameters

idstring required

Response

Avatar profile

idstring uuid required

Avatar profile ID. Pass this as avatar_profile_id in an AI Avatar tile.

video_preview_urlstring uri nullable required

Signed video preview URL. Null until a preview/reference video is available.

namestring required

Avatar display name.

status'pending' | 'processing' | 'ready' | 'failed' required

Avatar processing state. Ready means fully prepared; pending/processing can be used while the run waits; failed cannot be used.

status_messagestring nullable required

Error message when status is failed; otherwise null.

Changes

No recorded changes to this operation across all 1 revision of this API.