Skip to main content
POST
/
v1
/
avatars
/
preview
Preview Avatar
curl --request POST \
  --url https://api.agenthuman.com/v1/avatars/preview \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "avatar_id": "<string>"
}
'
{
  "success": true,
  "url": "https://links.agenthuman.com/lnk_01J8ZK4R2N5M6P7Q8W4T"
}
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

​
avatar_id
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

​
success
boolean
Whether the preview link was created successfully.
​
url
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.
{
  "success": true,
  "url": "https://links.agenthuman.com/lnk_01J8ZK4R2N5M6P7Q8W4T"
}