Get Public Avatar List
curl --request GET \
--url https://api.jogg.ai/v2/avatars/public \
--header 'x-api-key: <api-key>'import requests
url = "https://api.jogg.ai/v2/avatars/public"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.jogg.ai/v2/avatars/public', 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.jogg.ai/v2/avatars/public",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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.jogg.ai/v2/avatars/public"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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.jogg.ai/v2/avatars/public")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.jogg.ai/v2/avatars/public")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"code": 0,
"msg": "Success",
"data": {
"avatars": [
{
"id": 123,
"name": "Professional Female",
"video_url": "https://example.com/video.mp4",
"cover_url": "https://example.com/cover.jpg",
"aspect_ratio": 1,
"style": "professional",
"gender": "female",
"age": "adult"
}
]
}
}Avatar
Get Public Avatars
Retrieve list of public avatars with filtering options. Supports pagination and various filters including aspect ratio, style, gender, age, scene, and ethnicity.
GET
/
v2
/
avatars
/
public
Get Public Avatar List
curl --request GET \
--url https://api.jogg.ai/v2/avatars/public \
--header 'x-api-key: <api-key>'import requests
url = "https://api.jogg.ai/v2/avatars/public"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.jogg.ai/v2/avatars/public', 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.jogg.ai/v2/avatars/public",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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.jogg.ai/v2/avatars/public"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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.jogg.ai/v2/avatars/public")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.jogg.ai/v2/avatars/public")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"code": 0,
"msg": "Success",
"data": {
"avatars": [
{
"id": 123,
"name": "Professional Female",
"video_url": "https://example.com/video.mp4",
"cover_url": "https://example.com/cover.jpg",
"aspect_ratio": 1,
"style": "professional",
"gender": "female",
"age": "adult"
}
]
}
}Retrieve the list of public avatars available from the JoggAI library. These avatars can be used immediately in your videos.
Example Usage
curl --request GET \
--url 'https://api.jogg.ai/v2/avatars/public' \
--header 'x-api-key: YOUR_API_KEY'
Related Guides
Create Avatar Videos
Use avatars to create videos
Authorizations
API key for authentication. Obtain your key from the JoggAI dashboard.
Query Parameters
Page number for pagination
Required range:
x >= 1Example:
1
Number of items per page
Required range:
1 <= x <= 100Example:
10
Filter by aspect ratio
Available options:
portrait, landscape, square Example:
"portrait"
Filter by avatar style
Available options:
professional, social Filter by avatar gender
Available options:
female, male Filter by age group
Available options:
adult, senior, young_adult Filter by scene type
Available options:
lifestyle, outdoors, business, studio, health_fitness, education, news Filter by ethnicity
Available options:
european, african, south_asian, east_asian, middle_eastern, south_american, north_american Response
200 - application/json
Success
Business status code:
- 0 - Success
- 10104 - Record not found
- 10105 - Invalid API key
- 18020 - Insufficient credit
- 18025 - No permission to call APIs
- 40000 - Parameter error
- 50000 - System error
Example:
0
Response message
Example:
"Success"
Show child attributes
Show child attributes

