PATCH
/
api
/
v1
/
avatars
/
{avatarId}
Update avatar
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayName: '<string>',
    defaultVoiceId: '<string>',
    settings: {},
    metadata: {}
  })
};

fetch('https://realtimeavatar.ai/api/v1/avatars/{avatarId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "<string>",
  "tenantId": "<string>",
  "displayName": "<string>",
  "modelId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "sourceAssetId": "<string>",
  "defaultVoiceId": "<string>",
  "cacheManifestId": "<string>",
  "cacheVersion": 1
}

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.

Path Parameters

​
avatarId
string
required

Platform avatar id (starts with ava_).

Pattern: ^ava_

Body

application/json

Provide at least one field.

​
displayName
string
Required string length: 1 - 160
​
defaultVoiceId
string | null
Required string length: 8 - 160
​
settings
object
​
metadata
object

Response

Updated avatar

​
id
string
required

Platform avatar id (ava_...). Use this in realtime prepare/turn calls.

​
tenantId
string
required
​
displayName
string
required
​
sourceKind
enum<string>
required
Available options:
image,
video
​
modelId
string
required
​
status
enum<string>
required
Available options:
draft,
preprocessing,
ready,
failed,
disabled,
deleted
​
createdAt
string
required
​
updatedAt
string
required
​
sourceAssetId
string | null
​
defaultVoiceId
string | null
​
cacheManifestId
string | null
​
cacheVersion
integer
Required range: x >= 0