Get Custom Avatars

Retrieve list of user’s instant avatars. Returns user’s custom instant avatar collection with filtering options.

GET /v2/avatars/custom

Get Instant Avatar List

cURL

curl --request GET \
  --url https://api.jogg.ai/v2/avatars/custom \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.jogg.ai/v2/avatars/custom"

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

	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/custom")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

200

{
  "code": 0,
  "msg": "Success",
  "data": {
    "avatars": [
      {
        "id": 123,
        "name": "My Instant Avatar",
        "video_url": "https://example.com/video.mp4",
        "cover_url": "https://example.com/cover.jpg",
        "api_only": true,
        "avatar_status": "completed",
        "fail_msg": "",
        "avatar_url": "https://example.com/avatar.mp4"
      }
    ]
  }
}

Retrieve the list of your custom avatars including photo avatars and product avatars.

Example Usage

curl --request GET \
  --url 'https://api.jogg.ai/v2/avatars/custom' \
  --header 'x-api-key: YOUR_API_KEY'

Authorizations

x-api-key · string · header · required

API key for authentication. Obtain your key from the JoggAI dashboard.

Query Parameters

page · integer · default: 1

Page number for pagination

Required range: x >= 1

Example:

1

page_size · integer · default: 10

Number of items per page

Required range: 1 <= x <= 100

Example:

10

name · string

Avatar name filter - search avatars by name

status · enum<string>

Status filter

Available options: processing, completed, failed

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

Example:

0

msg · string · required

Response message

Example:

"Success"

data · object

Show child attributes