Add Avatar - NavTalk API Documentation

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-video-avatar",
  "url": "https://example.com/avatar.mp4",
  "providerId": "b92a28fb2ea737457c7f13ba554759c0",
  "model": "agent_3201khcbet2vf349gpmtfg83q0hy",
  "voice": "CwhRBWXzGAHq8TQ4Fs17",
  "firstMessage": "Hi! How can I help you today?",
  "prompt": "You are a helpful assistant."
}
'

import requests

url = "https://api.navtalk.ai/api/open/v1/avatar/add"

payload = {
    "name": "my-video-avatar",
    "url": "https://example.com/avatar.mp4",
    "providerId": "b92a28fb2ea737457c7f13ba554759c0",
    "model": "agent_3201khcbet2vf349gpmtfg83q0hy",
    "voice": "CwhRBWXzGAHq8TQ4Fs17",
    "firstMessage": "Hi! How can I help you today?",
    "prompt": "You are a helpful assistant."
}
headers = {
    "license": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {license: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'my-video-avatar',
    url: 'https://example.com/avatar.mp4',
    providerId: 'b92a28fb2ea737457c7f13ba554759c0',
    model: 'agent_3201khcbet2vf349gpmtfg83q0hy',
    voice: 'CwhRBWXzGAHq8TQ4Fs17',
    firstMessage: 'Hi! How can I help you today?',
    prompt: 'You are a helpful assistant.'
  })
};

fetch('https://api.navtalk.ai/api/open/v1/avatar/add', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.navtalk.ai/api/open/v1/avatar/add",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'my-video-avatar',
    'url' => 'https://example.com/avatar.mp4',
    'providerId' => 'b92a28fb2ea737457c7f13ba554759c0',
    'model' => 'agent_3201khcbet2vf349gpmtfg83q0hy',
    'voice' => 'CwhRBWXzGAHq8TQ4Fs17',
    'firstMessage' => 'Hi! How can I help you today?',
    'prompt' => 'You are a helpful assistant.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "license: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.navtalk.ai/api/open/v1/avatar/add"

	payload := strings.NewReader("{\n  \"name\": \"my-video-avatar\",\n  \"url\": \"https://example.com/avatar.mp4\",\n  \"providerId\": \"b92a28fb2ea737457c7f13ba554759c0\",\n  \"model\": \"agent_3201khcbet2vf349gpmtfg83q0hy\",\n  \"voice\": \"CwhRBWXzGAHq8TQ4Fs17\",\n  \"firstMessage\": \"Hi! How can I help you today?\",\n  \"prompt\": \"You are a helpful assistant.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("license", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.navtalk.ai/api/open/v1/avatar/add")
  .header("license", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"my-video-avatar\",\n  \"url\": \"https://example.com/avatar.mp4\",\n  \"providerId\": \"b92a28fb2ea737457c7f13ba554759c0\",\n  \"model\": \"agent_3201khcbet2vf349gpmtfg83q0hy\",\n  \"voice\": \"CwhRBWXzGAHq8TQ4Fs17\",\n  \"firstMessage\": \"Hi! How can I help you today?\",\n  \"prompt\": \"You are a helpful assistant.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.navtalk.ai/api/open/v1/avatar/add")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["license"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"my-video-avatar\",\n  \"url\": \"https://example.com/avatar.mp4\",\n  \"providerId\": \"b92a28fb2ea737457c7f13ba554759c0\",\n  \"model\": \"agent_3201khcbet2vf349gpmtfg83q0hy\",\n  \"voice\": \"CwhRBWXzGAHq8TQ4Fs17\",\n  \"firstMessage\": \"Hi! How can I help you today?\",\n  \"prompt\": \"You are a helpful assistant.\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "message": "SUCCESS",
  "data": {
    "jobId": "096f43cf-4dbf-47d5-9583-8e3d0c3a5641",
    "avatarId": "fbc269dcd0a738cf8e5e0f465671303c"
  }
}

POST

api

open

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-video-avatar",
  "url": "https://example.com/avatar.mp4",
  "providerId": "b92a28fb2ea737457c7f13ba554759c0",
  "model": "agent_3201khcbet2vf349gpmtfg83q0hy",
  "voice": "CwhRBWXzGAHq8TQ4Fs17",
  "firstMessage": "Hi! How can I help you today?",
  "prompt": "You are a helpful assistant."
}
'

import requests

url = "https://api.navtalk.ai/api/open/v1/avatar/add"

payload = {
    "name": "my-video-avatar",
    "url": "https://example.com/avatar.mp4",
    "providerId": "b92a28fb2ea737457c7f13ba554759c0",
    "model": "agent_3201khcbet2vf349gpmtfg83q0hy",
    "voice": "CwhRBWXzGAHq8TQ4Fs17",
    "firstMessage": "Hi! How can I help you today?",
    "prompt": "You are a helpful assistant."
}
headers = {
    "license": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {license: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'my-video-avatar',
    url: 'https://example.com/avatar.mp4',
    providerId: 'b92a28fb2ea737457c7f13ba554759c0',
    model: 'agent_3201khcbet2vf349gpmtfg83q0hy',
    voice: 'CwhRBWXzGAHq8TQ4Fs17',
    firstMessage: 'Hi! How can I help you today?',
    prompt: 'You are a helpful assistant.'
  })
};

fetch('https://api.navtalk.ai/api/open/v1/avatar/add', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.navtalk.ai/api/open/v1/avatar/add",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'my-video-avatar',
    'url' => 'https://example.com/avatar.mp4',
    'providerId' => 'b92a28fb2ea737457c7f13ba554759c0',
    'model' => 'agent_3201khcbet2vf349gpmtfg83q0hy',
    'voice' => 'CwhRBWXzGAHq8TQ4Fs17',
    'firstMessage' => 'Hi! How can I help you today?',
    'prompt' => 'You are a helpful assistant.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "license: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.navtalk.ai/api/open/v1/avatar/add"

	payload := strings.NewReader("{\n  \"name\": \"my-video-avatar\",\n  \"url\": \"https://example.com/avatar.mp4\",\n  \"providerId\": \"b92a28fb2ea737457c7f13ba554759c0\",\n  \"model\": \"agent_3201khcbet2vf349gpmtfg83q0hy\",\n  \"voice\": \"CwhRBWXzGAHq8TQ4Fs17\",\n  \"firstMessage\": \"Hi! How can I help you today?\",\n  \"prompt\": \"You are a helpful assistant.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("license", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.navtalk.ai/api/open/v1/avatar/add")
  .header("license", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"my-video-avatar\",\n  \"url\": \"https://example.com/avatar.mp4\",\n  \"providerId\": \"b92a28fb2ea737457c7f13ba554759c0\",\n  \"model\": \"agent_3201khcbet2vf349gpmtfg83q0hy\",\n  \"voice\": \"CwhRBWXzGAHq8TQ4Fs17\",\n  \"firstMessage\": \"Hi! How can I help you today?\",\n  \"prompt\": \"You are a helpful assistant.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.navtalk.ai/api/open/v1/avatar/add")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["license"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"my-video-avatar\",\n  \"url\": \"https://example.com/avatar.mp4\",\n  \"providerId\": \"b92a28fb2ea737457c7f13ba554759c0\",\n  \"model\": \"agent_3201khcbet2vf349gpmtfg83q0hy\",\n  \"voice\": \"CwhRBWXzGAHq8TQ4Fs17\",\n  \"firstMessage\": \"Hi! How can I help you today?\",\n  \"prompt\": \"You are a helpful assistant.\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "message": "SUCCESS",
  "data": {
    "jobId": "096f43cf-4dbf-47d5-9583-8e3d0c3a5641",
    "avatarId": "fbc269dcd0a738cf8e5e0f465671303c"
  }
}

Media Requirements

The url field now supports both image and video files:

Images: jpg, jpeg, png, bmp, webp
Videos: mp4, mov, webm, avi, m4v

When using a video URL, the backend enforces:

Minimum duration: 2 seconds
Maximum resolution: 1920x1080

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 media file.

Supported image formats: jpg, jpeg, png, bmp, webp.

Supported video formats: mp4, mov, webm, avi, m4v.

Video constraints: minimum duration 2 seconds; maximum resolution 1920x1080.

Example:

"https://example.com/avatar.mp4"

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. For Cartesia agents, see Cartesia Voices 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

Show child attributes

Create Voice Update Avatar

​Media Requirements

Authorizations

Body

Response

Media Requirements