Skip to main content
POST
/
createAvatar
cURL
curl --request POST \
  --url https://api.duix.ai/duix-openapi-v2/sdk/v2/createAvatar \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "ttsName": "<string>",
  "conversationId": "<string>",
  "coverImage": "<string>",
  "defaultSpeakingLanguage": "<string>",
  "greetings": "<string>",
  "name": "<string>",
  "profile": "<string>"
}
'
{
  "code": "<string>",
  "msg": "<string>",
  "success": true,
  "data": {
    "taskId": "<string>"
  }
}

Authorizations

​
token
string
header
required

Token generated from your API keys.

Body

application/json

Avatar to add to the store

​
ttsName
string
required

TTS name, select the public TTS voice. See at Settings -> Avatar creator -> Select voice

​
conversationId
string
required

The conversation ID. Value is required when using public AI avatar Get Conversation ID

​
coverImage
string

A value is needed if you are using images to customize your AI avatar. Base64 format. e.g. data:image/png;base64,iVBORw0KGgoAAAANSUhEUgA

​
defaultSpeakingLanguage
string

Default speaking language. default English

​
greetings
string

Enter a greeting for your AI avatar’s first words, If not, the system will generate it randomly

​
name
string

Enter a name for your AI avatar. If not, the system will generate it randomly

​
profile
string

Enter a description of personality and preferences you’d love your AI avatar to have.. If not, the system will generate it randomly

Response

200 - application/json

plant response

​
code
string

Response code.

​
msg
string

Response message.

​
success
boolean

Indicates whether the request succeeded.

​
data
object

Response payload containing avatar details.