List Models

Returns all AI models available under the specified provider. The returned model field is used as the model parameter when creating an avatar.

GET /api/open/v1/model/list

List Models

cURL

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

import requests

url = "https://api.navtalk.ai/api/open/v1/model/list"

headers = {"license": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.navtalk.ai/api/open/v1/model/list', 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/model/list",
  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/model/list"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.navtalk.ai/api/open/v1/model/list")
  .header("license", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.navtalk.ai/api/open/v1/model/list")

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

200

{
  "code": 200,
  "message": "SUCCESS",
  "data": [
    {
      "model": "agent_3201khcbet2vf349gpmtfg83q0hy",
      "name": "GPT-4o Realtime"
    }
  ]
}

{
  "code": 400,
  "message": "Invalid license key"
}

Authorizations

license · string · header · required

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

Query Parameters

providerId · string · required

The provider ID (obtained from /provider/list)

Example:

"b92a28fb2ea737457c7f13ba554759c0"

Response

200

application/json

Model list retrieved successfully

code · integer

Example:

200

message · string

Example:

"SUCCESS"

data · object[]

Show child attributes