Create an avatar

Create an avatar record from an uploaded asset (see POST /api/v1/assets or POST /api/v1/assets/remote). Requires scope avatars:write.

Authorization

apiKey

AuthorizationBearer <token>

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.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

displayName*string

sourceKind*string

modelId?string

Avatar model id; defaults to the platform default model.

sourceAssetId?string

Asset id from POST /api/v1/assets or /api/v1/assets/remote.

defaultVoiceId?string

settings?

metadata?

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/avatars" \  -H "Content-Type: application/json" \  -d '{    "displayName": "string",    "sourceKind": "image"  }'

{  "id": "string",  "tenantId": "string",  "displayName": "string",  "sourceKind": "image",  "modelId": "string",  "sourceAssetId": "string",  "status": "draft",  "defaultVoiceId": "string",  "cacheManifestId": "string",  "cacheVersion": 0,  "createdAt": "string",  "updatedAt": "string"}

{  "error": "string",  "status": 0,  "code": "string",  "retryable": true,  "billingUrl": "string"}

{  "error": "string",  "status": 0,  "code": "string",  "retryable": true,  "billingUrl": "string"}

{  "error": "string",  "status": 0,  "code": "string",  "retryable": true,  "billingUrl": "string"}

Authorization

Request Body

Response Body

201application/json

401application/json

403application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`