tencent cloud

Tencent Cloud AI Digital Human

Product Overview
Overview
Product Features
Product Advantage
Purchase Guide
Pricing Guide
Purchase Guide
Process for Purchasing with Vouchers
Refund Instructions
Introduction of Avatar
Introduction to Image Categories
Basic Image Library
Guide on Avatar and Voice Clone
Digital Human Platform Operation Guide
Accessing Platform
Avatar Production and Asset Management
Digital Human Conversation Interaction Application and Management
Broadcast Digital Human Video Generation and Management
Operations Management and Analysis
Server API Integration
Digital Human API Access Mode Overview
Avatar aPaas API Calling Methods
Avatar Image Customization and Voice Clone API Documentation
Video Generation Service API Documentation
Interactive Digital Human Service API Documentation
Personal Asset Management API Documentation
Client SDK Integration
Overall Introduction
3D Client-Side Rendering SDK Integration
2D Client-Side Rendering SDK Integration
Digital Human SSML Markup Language Specification
Related Agreement
Privacy Policy
DSA (Data Sharing Agreement)
FAQs
DocumentationTencent Cloud AI Digital HumanServer API IntegrationPersonal Asset Management API DocumentationQuerying for Avatar List by Pagination API

Querying for Avatar List by Pagination API

PDF
Focus Mode
Font Size
Last updated: 2024-07-19 10:17:21
Query the Avatar list through pagination parameters.

Calling Protocol

HTTPS + JSON
POST /v2/ivh/crmserver/customerassetservice/describesmallsampleimage
Header Content-Type: application/json;charset=utf-8

Request Parameters

Parameters
Type
Mandatory
Description
PageIndex
int
Yes
Current page
PageSize
int
Yes
Page size (maximum of 100)
AnchorCodes
Array of string
No
Filter condition by AnchorCode

Response Parameter

Parameters
Type
Mandatory
Description
Virtualmans
Array of [SmallSampleImage]
Yes
Resources of the digital human within customers' permissions
Total
int
Yes
Totals
SmallSampleImage
Parameters
Type
Mandatory
Description
VirtualmanKey
string
Yes
Digital human virtualmanKey; a unique identifier for the avatar.
AnchorName
string
Yes
Anchor Name
AnchorCode
string
Yes
Anchor Code
ClothesName
string
Yes
Digital human clothing
PoseName
string
Yes
Digital human pose
Resolution
string
Yes
Digital human resolution
HeaderImage
string
Yes
Digital human avatar image URL
PoseImage
string
Yes
Digital human pose image URL
ClothesImage
string
Yes
Digital human clothing image URL
SupportDriverTypes
Array of [string]
Yes
Supported drive types of the digital human
1. Text: Text-driven
2. OriginalVoice: Original voice audio-driven
3. ModulatedVoice: Modulated voice audio-driven
ExpireDate
string
Yes
Validity Period
VideoDuration
int
Yes
Total accumulated duration for calling the digital human, in milliseconds.
VideoNum
int
Yes
Total number of videos for the digital human
OriginZoom
float
Yes
Initial zoom factor for the digital human
OriginZoomStr
String type floating point number
Yes
Initial scaling factor of the digital human, accurate to three decimal places
ReferenceVideoSegmentUrl
string
Yes
URL of the selected video clip for the Avatar.

Example

Input parameters:
{
    "Header": {},
    "Payload": {
        "pageIndex": 1,
        "PageSize": 10
    }
}
Output response:
{
    "Header": {
        "Code": 0,
        "Message": "",
        "RequestID": "123"
    },
    "Payload": {
        "Virtualmans": [
            {
                "VirtualmanKey": "6d266ff720f04df39b8e0a17553382d1",
                "AnchorName": "Teacher Wuji",
                "AnchorCode": "wuji_teacher_v3",
                "ClothesName": "polo shirt",
                "PoseName": "Standing",
                "Resolution": "1920x1080",
                "HeaderImage": "url",
                "PoseImage": "url",
                "ClothesImage": "url",
                "SupportDriverTypes": [
                    "Text",
                    "OriginalVoice"
                ],
                "ExpireDate": "2023-04-01 00:00:00",
                "VideoDuration": 50000,
                "VideoNum": 3,
                "OriginZoom": 0.50
            }
        ],
        "Total": 22
    }
}

Previous Topic: Digital Human aPaaS API Calling MethodsNext Topic: Querying Supported Timbres for Avatars (to be Deprecated)

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback