v4

latestOpenAPI 3.1.02026-08-086635375.7 KB

Avatars

update avatar

Update an avatar by ID (only display name can be updated)

put/v1/avatars/{id}

Path parameters

idstring uuid required

Avatar ID

Request body

displayNamestring required

New display name for the avatar

Response

Successfully updated avatar

idstring uuid

Unique identifier for the avatar.

displayNamestring

Human-readable name shown in the Lab and share links.

variantNamestring

Name of the specific variant (e.g. lighting or pose) within the avatar family.

imageUrlstring uri

URL of the still image used as a preview of the avatar.

landscapeImageUrlstring uri nullable

Preview image cropped exactly as the engine frames landscape (1152x768) output. Use this when displaying the avatar at a landscape aspect ratio. For avatars with legacy landscape source images this is the same as imageUrl.

portraitImageUrlstring uri nullable

Preview image cropped exactly as the engine frames portrait (768x1152) output. Use this when starting a session with portrait videoWidth/videoHeight. null when the avatar cannot render portrait output.

videoUrlstring uri nullable

Signed URL for a muted MP4 preview of the avatar, if one exists. The URL expires after 1 hour; re-fetch the avatar to get a fresh URL. null when the preview is unavailable or still generating.

idleVideoUrlstring uri nullable

Signed URL for a muted idling-loop MP4 of the avatar, if one exists. The URL expires after 1 hour; re-fetch the avatar to get a fresh URL. null when unavailable or still generating.

createdAtstring date-time

Timestamp when the avatar was created.

updatedAtstring date-time

Timestamp when the avatar was last updated.

createdByOrganizationIdstring nullable

ID of the organization that created the avatar, or null for stock avatars. IDs may be either UUIDs or nanoid-style strings depending on when the organization was created.

availableVersionsstring[]

Avatar models this avatar can be used with. Pass one of these values as avatarModel when creating a persona or starting a session.

activeVersionstring nullable

Avatar model used by default when no explicit avatarModel is requested.

descriptionstring nullable

AI-generated description of the avatar's appearance, setting, and style. null if metadata generation has not completed.

displayTagsstring[]

Curated tags describing the avatar. Empty array if metadata generation has not completed.

renderStyle'realistic' | 'animated_3d' | 'illustrated' | 'unknown'

Render style of the avatar. unknown covers custom avatars and avatars whose metadata has not yet been generated.