Skip to main content
GET
/
v2
/
avatars
/
custom
Get Instant Avatar List
curl --request GET \
  --url https://api.jogg.ai/v2/avatars/custom \
  --header 'x-api-key: <api-key>'
{
  "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