Avatars

Update an avatar

Requires an API key with the avatars:write scope.

patch/v1/avatars/{avatarId}

Request

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

Path parameters

avatarIdstring required

Request body

displayNamestring
defaultVoiceIdstring nullable
llmProvider'local' | 'gemini' | 'openai'
llmModelstring nullable
settingsobject
metadataobject
artDirectionstring
stylePreset'cinematic-founder' | 'editorial-companion' | 'warm-anime' | 'luxury-realism' | 'soft-3d' | 'noir-avatar'
portraitUrlstring uri

Dashboard-only. updateAvatar needs a request/env context to pull the image into tenant storage, and the public route does not supply one, so sending this here is always 400 Portrait updates are not available on this route. To change the portrait over this API, register the image with POST /v1/assets or POST /v1/assets/remote and PATCH the returned id as sourceAssetId, which is the swap lane and does work.

sourceAssetIdstring
anchorTimeMsinteger

Response

Updated

idstring required
tenantIdstring required
displayNamestring required
sourceKind'image' | 'video' required
modelId'realtime-avatar-live-v1' | 'realtime-avatar-video-v1' required
sourceAssetIdstring nullable required
status'draft' | 'preprocessing' | 'ready' | 'failed' | 'disabled' | 'deleted' required
errorstring nullable required
idleVideoStatus'none' | 'queued' | 'generating' | 'ready' | 'failed' required
defaultVoiceIdstring nullable required
createdAtstring required
updatedAtstring required

Changes

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