Skip to main content
POST
/
api
/
open
/
v1
/
avatar
/
add
Add Avatar
curl --request POST \
  --url https://api.navtalk.ai/api/open/v1/avatar/add \
  --header 'Content-Type: application/json' \
  --header 'license: <api-key>' \
  --data '
{
  "name": "my-image-avatar",
  "url": "https://example.com/photo.jpg",
  "providerId": "b92a28fb2ea737457c7f13ba554759c0",
  "model": "agent_3201khcbet2vf349gpmtfg83q0hy",
  "voice": "CwhRBWXzGAHq8TQ4Fs17",
  "firstMessage": "Hi! How can I help you today?",
  "prompt": "You are a helpful assistant."
}
'
{ "code": 200, "message": "SUCCESS", "data": { "jobId": "096f43cf-4dbf-47d5-9583-8e3d0c3a5641", "avatarId": "fbc269dcd0a738cf8e5e0f465671303c" } }

Authorizations

​
license
string
header
required

NavTalk API license key (e.g. sk_navtalk_...)

Body

application/json
​
name
string
required

Display name for the avatar. Must be unique per account.

Example:

"my-video-avatar"

​
url
string
required

URL of the source image file. Supported image formats: jpg, jpeg, png, bmp, webp. Video upload is not allowed.

Example:

"https://example.com/photo.jpg"

​
providerId
string
required

The provider ID to use (obtained from /provider/list).

Example:

"b92a28fb2ea737457c7f13ba554759c0"

​
model
string
required

The model key to use (obtained from /model/list). For ElevenLabs agents, see ElevenLabs Agents Quickstart.

Example:

"agent_3201khcbet2vf349gpmtfg83q0hy"

​
voice
string
required

The voice key to use (obtained from /voice/list).

Example:

"CwhRBWXzGAHq8TQ4Fs17"

​
firstMessage
string

Optional opening message the avatar says at the start of a conversation.

Example:

"Hi! How can I help you today?"

​
prompt
string

Optional system prompt that controls the avatar's behavior and personality.

Example:

"You are a helpful assistant."

Response

Avatar training job created successfully

​
code
integer
Example:

200

​
message
string
Example:

"SUCCESS"

​
data
object