Skip to main content
GET
/
avatar-profiles
Get Avatars
curl --request GET \
  --url https://api.example.com/avatar-profiles

Documentation Index

Fetch the complete documentation index at: https://docs.mosaic.so/llms.txt

Use this file to discover all available pages before exploring further.

Returns avatars from your organization’s primary workspace. Avatars created through the API are stored there so AI Avatar tiles in any workspace can use them. Each avatar includes status. You can use avatars with pending or processing status immediately; the AI Avatar run waits for processing to finish. Avatars with failed status cannot be used.

​
Request

curl "https://api.mosaic.so/avatar-profiles" \
  -H "Authorization: Bearer mk_your_api_key"

​
Response

Returns an object with avatar_profiles, an array of avatar profile objects:
FieldTypeDescription
avatar_profilesarrayList of avatar profiles available to your organization.
avatar_profiles[].idstring UUIDAvatar profile ID. Pass this as avatar_profile_id in an AI Avatar tile.
avatar_profiles[].video_preview_urlstring URL | nullSigned video preview URL. This is null until a preview/reference video is available.
avatar_profiles[].namestringAvatar display name.
avatar_profiles[].status"pending" | "processing" | "ready" | "failed"Avatar processing state. ready means the avatar is fully prepared. pending or processing can still be used in an AI Avatar tile; the run waits. failed means the avatar cannot be used.
avatar_profiles[].status_messagestring | nullError message when status is failed; otherwise null.
{
  "avatar_profiles": [
    {
      "id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
      "video_preview_url": "https://...",
      "name": "Founder Avatar",
      "status": "ready",
      "status_message": null
    }
  ]
}
Use id as avatar_profile_id in an AI Avatar node.