Skip to main content
GET
/
avatars
Get Avatar List
curl --request GET \
  --url https://api.jogg.ai/v1/avatars \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.jogg.ai/v1/avatars"

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/v1/avatars', 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/v1/avatars",
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/v1/avatars"

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/v1/avatars")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.jogg.ai/v1/avatars")

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": 123,
  "msg": "<string>",
  "data": {
    "avatars": [
      {
        "avatar_id": 81,
        "name": "Amanda outdoors",
        "cover_url": "https://res.jogg.ai/f178cf5273dd9cbd506f27426966c1ae501cae27-cover.png",
        "aspect_ratio": 0,
        "style": "professional",
        "gender": "female",
        "age": "adult"
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

Query Parameters

aspect_ratio
enum<integer>

Screen aspect ratio:

  • 0 - [9:16]

  • 1 - [16:9]

  • 2 - [1:1]

Available options:
0,
1,
2
style
enum<string>

Avatar style:

  • professional

  • social

Available options:
professional,
social
gender
enum<string>

Avatar gender:

  • male

  • female

Available options:
male,
female
age
enum<string>

Avatar age:

  • adult

  • senior

  • young_adult

Available options:
adult,
senior,
young_adult
scene
enum<string>

Avatar scene:

  • lifestyle
  • outdoors
  • business
  • studio
  • health_fitness
  • education
  • news
Available options:
lifestyle,
outdoors,
business,
studio,
health_fitness,
education,
news
ethnicity
enum<string>

Avatar ethnicity:

  • european
  • african
  • south_asian
  • east_asian
  • middle_eastern
  • south_american
  • north_american
Available options:
european,
african,
south_asian,
east_asian,
middle_eastern,
south_american,
north_american

Response

200 - application/json

Success

code
integer
required

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

msg
string
required

Response message

data
object