Skip to main content
POST
Preview Avatar
What This Does: Creates a temporary agent and a one-time preview link that expires in 5 minutes. Opening the returned URL launches a live video session using the specified avatar, so you can see exactly how it will look and behave before using it in production.

Body

string
required
The avatar ID to preview (format: avat_<ULID> or a pre-built avatar ID such as PUBLIC/Avatars/sara-office). Returned by Upload Face Avatar or found via List Avatars.

Response

boolean
Whether the preview link was created successfully.
string
A one-time preview URL (expires in 5 minutes, single-use). Open this in a browser to start a live video session with the avatar.