Avatar Assets¶

Avatar assets define the visual identity of a digital human. OpenTalking now treats avatars as shared session assets: the same avatar can be reused by different talking-head models, and each model creates its own cache, template, or preprocessing artifacts when needed.

Minimal Rules¶

A usable avatar bundle should include:

manifest.json: basic identity, display name, size, frame rate, and sample rate.
preview.png: image used by the WebUI avatar library.
Optional assets: a reference image, extracted frames, a template video, or model-generated cache.

Do not document avatars as QuickTalk-, MuseTalk-, or Wav2Lip-only assets. Model-specific derivatives such as QuickTalk templates, Wav2Lip reference frames, or MuseTalk prepared/ files should be generated by preparation scripts, upload flows, or deployment commands.

Example manifest¶

examples/avatars/demo-avatar/manifest.json

{
  "id": "demo-avatar",
  "name": "Demo Avatar",
  "fps": 25,
  "sample_rate": 16000,
  "width": 512,
  "height": 512,
  "metadata": {}
}

Prepare and validate¶

Use the existing avatar guide for the complete schema and preparation scripts:

Verify the server sees the avatar:

terminal

curl -s http://127.0.0.1:8000/avatars | jq

When troubleshooting, check three values together: the session model, whether the avatar is readable by the service, and whether the matching /models backend is connected.