Skip to main content
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>'
{
  "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'

Create Avatar Videos

Use avatars to create videos

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

​
aspect_ratio
enum<string>

Filter by aspect ratio

Available options:
portrait,
landscape,
square
Example:

"portrait"

​
style
enum<string>

Filter by avatar style

Available options:
professional,
social
​
gender
enum<string>

Filter by avatar gender

Available options:
female,
male
​
age
enum<string>

Filter by age group

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

Filter by scene type

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

Filter by ethnicity

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
Example:

0

​
msg
string
required

Response message

Example:

"Success"

​
data
object