Skip to main content
GET

Overview

Returns one of your team’s own avatars: its status, image and tags, and its Hook + Demo reactions. Poll it after Generate Avatar until status is COMPLETED or FAILED, and after Create Reaction until the reaction is. Library avatars are not served here; List Avatars has them. Another team’s avatar, a deleted one or an id that is not one answers 404 Avatar not found. Each reaction is PROCESSING, COMPLETED (with videoUrl and thumbnailUrl) or FAILED. The image and video URLs are signed and expire; read them again rather than storing them.

Authorizations

x-api-key
string
header
required

Path Parameters

avatarId
string
required

The id of one of your team's own avatars (from List Avatars with type=custom, or a create call). Library avatars are not accepted here.

Response

The avatar

success
boolean
required
data
object
required

One of your team's own avatars (an Actor under My Actors in the dashboard).

message
string