POST
/
api
/
v1
/
realtime
/
prepare
Prepare an avatar for realtime
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({avatar_id: '<string>'})
};

fetch('https://realtimeavatar.ai/api/v1/realtime/prepare', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "avatar_id": "<string>",
  "renderer_avatar_id": "<string>",
  "model_id": "<string>",
  "backend_id": "<string>",
  "status": "<string>",
  "registered": true,
  "timings": {},
  "video_cache": {}
}

Authorizations

​
Authorization
string
header
required

TIC API key as a bearer token: Authorization: Bearer tic_live_... or tic_test_.... Create keys in the dashboard at /platform/dashboard or via POST /api/v1/api-keys.

Body

application/json
​
avatar_id
string
required

Platform avatar id (ava_...).

​
source_kind
enum<string>
default:portrait
Available options:
portrait,
source_video
​
video_cache_id
string | null
​
video_cache
object

Source-video cache settings overrides.

Response

Avatar prepared

​
avatar_id
string
required

Platform avatar id you sent.

​
renderer_avatar_id
string | null

Internal renderer avatar id.

​
model_id
string
​
backend_id
string
​
status
string
Allowed value: "ready"
​
registered
boolean
​
source_kind
enum<string>
Available options:
portrait,
source_video
​
timings
object
​
video_cache
object

Video cache manifest when source_kind is source_video.