Get Avatar Status - NavTalk API Documentation

Get Avatar Status

curl --request GET \
  --url https://api.navtalk.ai/api/open/v1/avatar/status \
  --header 'license: <api-key>'

const options = {method: 'GET', headers: {license: '<api-key>'}};

fetch('https://api.navtalk.ai/api/open/v1/avatar/status', 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/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("license", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["license"] = '<api-key>'

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

{
  "code": 200,
  "message": "SUCCESS",
  "data": "Success"
}

GET

api

open

avatar

status

Get Avatar Status

curl --request GET \
  --url https://api.navtalk.ai/api/open/v1/avatar/status \
  --header 'license: <api-key>'

const options = {method: 'GET', headers: {license: '<api-key>'}};

fetch('https://api.navtalk.ai/api/open/v1/avatar/status', 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/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("license", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["license"] = '<api-key>'

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

{
  "code": 200,
  "message": "SUCCESS",
  "data": "Success"
}

Authorizations

license

string

header

required

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

Query Parameters

jobId

string

required

The job ID returned by /avatar/add

Example:

"096f43cf-4dbf-47d5-9583-8e3d0c3a5641"

Response

Status retrieved successfully

code

integer

Example:

200

message

string

Example:

"SUCCESS"

data

enum<string>

Current training status of the avatar.

Available options:

Draft,

Pending,

Processing,

Success,

Failed

Example:

"Success"

Delete Avatar List Avatars