Avatar
Get Photo Avatar List
QuickStart
API Documentation
URL to Video
Create Avatar Videos
Get Generated Video
AI Scripts
Upload Media
Avatar
Visual Style
Avatar
Get Photo Avatar List
Get a list of your photo avatar
GET
/
avatars
/
photo_avatars
curl --request GET \
--url https://api.jogg.ai/v1/avatars/photo_avatars \
--header 'x-api-key: <api-key>'
{
"code": 123,
"msg": "<string>",
"data": {
"avatars": [
{
"avatar_id": 12345,
"name": "My Photo Avatar",
"cover_url": "https://example.com/avatar/cover.jpg",
"status": 1,
"fail_msg": "",
"aspect_ratio": 9,
"style": "professional",
"gender": "male",
"age": "25-35"
}
]
}
}
Authorizations
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
Response message
Avatar ID
Example:
12345
Avatar name
Example:
"My Photo Avatar"
Cover image URL
Example:
"https://example.com/avatar/cover.jpg"
Avatar status
- 0 - in progress
- 1 - success
- 2 - failed
Available options:
0
, 1
, 2
Example:
1
Error message when status is failed
Example:
""
Aspect ratio of the avatar
Example:
9
Avatar style
Example:
"professional"
Avatar gender
Example:
"male"
Avatar age range
Example:
"25-35"
curl --request GET \
--url https://api.jogg.ai/v1/avatars/photo_avatars \
--header 'x-api-key: <api-key>'
{
"code": 123,
"msg": "<string>",
"data": {
"avatars": [
{
"avatar_id": 12345,
"name": "My Photo Avatar",
"cover_url": "https://example.com/avatar/cover.jpg",
"status": 1,
"fail_msg": "",
"aspect_ratio": 9,
"style": "professional",
"gender": "male",
"age": "25-35"
}
]
}
}