GET
/
avatars
curl --request GET \
  --url https://api.jogg.ai/v1/avatars \
  --header 'x-api-key: <api-key>'
{
  "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

The response is of type object.

GET
/
avatars
curl --request GET \
  --url https://api.jogg.ai/v1/avatars \
  --header 'x-api-key: <api-key>'
{
  "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

The response is of type object.