Update Avatar - NavTalk API Documentation

Update Avatar

curl --request POST \
  --url https://api.navtalk.ai/api/open/v1/avatar/update \
  --header 'Content-Type: application/json' \
  --header 'license: <api-key>' \
  --data '
{
  "id": "fbc269dcd0a738cf8e5e0f465671303c",
  "name": "my-updated-avatar",
  "providerId": "b92a28fb2ea737457c7f13ba554759c0",
  "model": "agent_3201khcbet2vf349gpmtfg83q0hy",
  "voice": "CwhRBWXzGAHq8TQ4Fs17",
  "firstMessage": "Hello! How may I assist you?",
  "prompt": "You are a friendly customer service assistant."
}
'

import requests

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

payload = {
    "id": "fbc269dcd0a738cf8e5e0f465671303c",
    "name": "my-updated-avatar",
    "providerId": "b92a28fb2ea737457c7f13ba554759c0",
    "model": "agent_3201khcbet2vf349gpmtfg83q0hy",
    "voice": "CwhRBWXzGAHq8TQ4Fs17",
    "firstMessage": "Hello! How may I assist you?",
    "prompt": "You are a friendly customer service 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({
    id: 'fbc269dcd0a738cf8e5e0f465671303c',
    name: 'my-updated-avatar',
    providerId: 'b92a28fb2ea737457c7f13ba554759c0',
    model: 'agent_3201khcbet2vf349gpmtfg83q0hy',
    voice: 'CwhRBWXzGAHq8TQ4Fs17',
    firstMessage: 'Hello! How may I assist you?',
    prompt: 'You are a friendly customer service assistant.'
  })
};

fetch('https://api.navtalk.ai/api/open/v1/avatar/update', 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/update",
  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([
    'id' => 'fbc269dcd0a738cf8e5e0f465671303c',
    'name' => 'my-updated-avatar',
    'providerId' => 'b92a28fb2ea737457c7f13ba554759c0',
    'model' => 'agent_3201khcbet2vf349gpmtfg83q0hy',
    'voice' => 'CwhRBWXzGAHq8TQ4Fs17',
    'firstMessage' => 'Hello! How may I assist you?',
    'prompt' => 'You are a friendly customer service 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/update"

	payload := strings.NewReader("{\n  \"id\": \"fbc269dcd0a738cf8e5e0f465671303c\",\n  \"name\": \"my-updated-avatar\",\n  \"providerId\": \"b92a28fb2ea737457c7f13ba554759c0\",\n  \"model\": \"agent_3201khcbet2vf349gpmtfg83q0hy\",\n  \"voice\": \"CwhRBWXzGAHq8TQ4Fs17\",\n  \"firstMessage\": \"Hello! How may I assist you?\",\n  \"prompt\": \"You are a friendly customer service 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/update")
  .header("license", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"fbc269dcd0a738cf8e5e0f465671303c\",\n  \"name\": \"my-updated-avatar\",\n  \"providerId\": \"b92a28fb2ea737457c7f13ba554759c0\",\n  \"model\": \"agent_3201khcbet2vf349gpmtfg83q0hy\",\n  \"voice\": \"CwhRBWXzGAHq8TQ4Fs17\",\n  \"firstMessage\": \"Hello! How may I assist you?\",\n  \"prompt\": \"You are a friendly customer service assistant.\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"id\": \"fbc269dcd0a738cf8e5e0f465671303c\",\n  \"name\": \"my-updated-avatar\",\n  \"providerId\": \"b92a28fb2ea737457c7f13ba554759c0\",\n  \"model\": \"agent_3201khcbet2vf349gpmtfg83q0hy\",\n  \"voice\": \"CwhRBWXzGAHq8TQ4Fs17\",\n  \"firstMessage\": \"Hello! How may I assist you?\",\n  \"prompt\": \"You are a friendly customer service assistant.\"\n}"

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

{
  "code": 200,
  "message": "SUCCESS",
  "data": "Avatar updated successfully"
}

POST

api

open

avatar

update

Update Avatar

curl --request POST \
  --url https://api.navtalk.ai/api/open/v1/avatar/update \
  --header 'Content-Type: application/json' \
  --header 'license: <api-key>' \
  --data '
{
  "id": "fbc269dcd0a738cf8e5e0f465671303c",
  "name": "my-updated-avatar",
  "providerId": "b92a28fb2ea737457c7f13ba554759c0",
  "model": "agent_3201khcbet2vf349gpmtfg83q0hy",
  "voice": "CwhRBWXzGAHq8TQ4Fs17",
  "firstMessage": "Hello! How may I assist you?",
  "prompt": "You are a friendly customer service assistant."
}
'

import requests

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

payload = {
    "id": "fbc269dcd0a738cf8e5e0f465671303c",
    "name": "my-updated-avatar",
    "providerId": "b92a28fb2ea737457c7f13ba554759c0",
    "model": "agent_3201khcbet2vf349gpmtfg83q0hy",
    "voice": "CwhRBWXzGAHq8TQ4Fs17",
    "firstMessage": "Hello! How may I assist you?",
    "prompt": "You are a friendly customer service 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({
    id: 'fbc269dcd0a738cf8e5e0f465671303c',
    name: 'my-updated-avatar',
    providerId: 'b92a28fb2ea737457c7f13ba554759c0',
    model: 'agent_3201khcbet2vf349gpmtfg83q0hy',
    voice: 'CwhRBWXzGAHq8TQ4Fs17',
    firstMessage: 'Hello! How may I assist you?',
    prompt: 'You are a friendly customer service assistant.'
  })
};

fetch('https://api.navtalk.ai/api/open/v1/avatar/update', 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/update",
  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([
    'id' => 'fbc269dcd0a738cf8e5e0f465671303c',
    'name' => 'my-updated-avatar',
    'providerId' => 'b92a28fb2ea737457c7f13ba554759c0',
    'model' => 'agent_3201khcbet2vf349gpmtfg83q0hy',
    'voice' => 'CwhRBWXzGAHq8TQ4Fs17',
    'firstMessage' => 'Hello! How may I assist you?',
    'prompt' => 'You are a friendly customer service 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/update"

	payload := strings.NewReader("{\n  \"id\": \"fbc269dcd0a738cf8e5e0f465671303c\",\n  \"name\": \"my-updated-avatar\",\n  \"providerId\": \"b92a28fb2ea737457c7f13ba554759c0\",\n  \"model\": \"agent_3201khcbet2vf349gpmtfg83q0hy\",\n  \"voice\": \"CwhRBWXzGAHq8TQ4Fs17\",\n  \"firstMessage\": \"Hello! How may I assist you?\",\n  \"prompt\": \"You are a friendly customer service 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/update")
  .header("license", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"fbc269dcd0a738cf8e5e0f465671303c\",\n  \"name\": \"my-updated-avatar\",\n  \"providerId\": \"b92a28fb2ea737457c7f13ba554759c0\",\n  \"model\": \"agent_3201khcbet2vf349gpmtfg83q0hy\",\n  \"voice\": \"CwhRBWXzGAHq8TQ4Fs17\",\n  \"firstMessage\": \"Hello! How may I assist you?\",\n  \"prompt\": \"You are a friendly customer service assistant.\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"id\": \"fbc269dcd0a738cf8e5e0f465671303c\",\n  \"name\": \"my-updated-avatar\",\n  \"providerId\": \"b92a28fb2ea737457c7f13ba554759c0\",\n  \"model\": \"agent_3201khcbet2vf349gpmtfg83q0hy\",\n  \"voice\": \"CwhRBWXzGAHq8TQ4Fs17\",\n  \"firstMessage\": \"Hello! How may I assist you?\",\n  \"prompt\": \"You are a friendly customer service assistant.\"\n}"

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

{
  "code": 200,
  "message": "SUCCESS",
  "data": "Avatar updated successfully"
}

Authorizations

license

string

header

required

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

Body

application/json

string

required

The avatar ID to update.

Example:

"fbc269dcd0a738cf8e5e0f465671303c"

name

string

required

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

Example:

"my-updated-avatar"

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:

"Hello! How may I assist you?"

prompt

string

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

Example:

"You are a friendly customer service assistant."

Response

Avatar updated successfully

code

integer

Example:

200

message

string

Example:

"SUCCESS"

data

string

Example:

"Avatar deleted successfully"

Add Avatar Get Avatar Detail