MOmosaic
Avatar Profiles

Create avatar

Create a reusable AI Avatar in the organization's primary workspace. Provide either a video source or an image plus audio source. Sources should represent one person only, with clean single-speaker audio from that person. URL sources are stored as Mosaic asset records.

post/avatar-profiles/create

Request

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

Request body

namestring required

Response

Avatar profile created

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.