Avatars

Declare an avatar's clip library

Declare the avatar's full desired clip library; see https://realtimeavatar.ai/docs/editing. The platform reconciles: unchanged clips are kept, changed or new ones re-render in the background against the avatar's pose anchor, absent ones soft-retire. 202 returns the post-apply library plus the reconcile plan. Supports Idempotency-Key replay and expectedRevision compare-and-set.

Requires an API key with the avatars:write scope.

put/v1/avatars/{avatarId}/clips

Request

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

Path parameters

avatarIdstring required

Headers

Idempotency-Keystring

Replays the original response byte-for-byte instead of performing the write again. Recommended on retries: a re-render is billed. Keys longer than 180 characters are IGNORED — the write proceeds without replay protection rather than failing — so keep it short.

Request body

expectedRevisioninteger required
clipsobject required
actionsobject

Response

Declaration accepted

avatarIdstring required
revisioninteger required
anchorVersioninteger required
clipLibraryEligibleboolean required
defaultSourceAssetIdstring nullable required

Changes

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