JOjogg
Avatar

List product avatars

Changed on

Get list of user's product avatars with optional aspect ratio filter. Supports filtering avatars by different aspect ratios for various video formats.

get/v2/avatars/product_avatars

Request

  • Base URL
    https://api.jogg.ai
  • URL
    https://api.jogg.ai/v2/avatars/product_avatars
  • Auth
    API key in header x-api-key

Query parameters

aspect_ratio'portrait' | 'landscape'
Example:portrait

Filter by aspect ratio

Response

Success

codeinteger 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
msgstring required

Response message

Example response

{
  "msg": "Success",
  "data": {
    "product_avatars": [
      {
        "avatar_id": 123,
        "name": "Product Presenter",
        "cover_url": "https://example.com/cover.jpg",
        "status": 1,
        "avatar_url": "https://example.com/avatar.mp4",
        "gender": "female"
      }
    ]
  }
}

Changes