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 Image Asset Information - Querying all Avatars under the Anchor

Querying Image Asset Information - Querying all Avatars under the Anchor

PDF
Focus Mode
Font Size
Last updated: 2024-07-19 10:19:57
Query image asset information and retrieve all the avatars assigned under a certain anchor.

Calling Protocol

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

Request Parameters

Parameters
Type
Mandatory
Description
VirtualmanTypeCode
string
Yes
Digital human type code, see Appendix 3 - Digital Human Type.
AnchorCode
Array of [string]
No
Digital human anchor code
PageIndex
int
Yes
Current page
PageSize
int
Yes
Page size (maximum of 100)

Response Parameter

Parameters
Type
Mandatory
Description
Virtualmans
Array of [Virtualman]
Yes
The avatars under this anchor
Total
int
Yes
Totals
ImageAssetDetail
Parameters
Type
Mandatory
Description
AnchorName
string
Yes
Digital human anchor name
AnchorCode
string
Yes
Digital human anchor code
VirtualmanType
string
Yes
Digital human type
VirtualmanTypeCode
string
Yes
Digital human type code
VirtualmanKey
string
Yes
Digital human virtualmankey
ClothesName
string
Yes
Digital human clothing name
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
Text: Text-driven
OriginalVoice: Original voice audio-driven
ModulatedVoice: Modulated voice audio-driven
SupportAnchorExtraParams
Array of [SupportAnchorExtraParam]
Yes
Description of configurable parameters for the digital human avatars: Currently only 3D clothing color change parameters are included.
VideoDuration
int64
Yes
Total accumulated duration for calling the digital human, in milliseconds.
VideoNum
int64
Yes
Total number of videos for the digital human
ExpireDate
string
Yes
Validity Period
OriginZoom
string
Yes
Zoom factor, rounded to three decimal places
ReferenceVideoSegmentUrl
string
Yes
Select Video Clips
SupportAnchorExtraParam
Parameters
Type
Mandatory
Description
Key
string
Yes
Configuration Item Name
Description
string
Yes
Configuration Item Description
Type
int
Yes
The value type of the configuration item. 1: string; 2: value; 3: boolean
Value
string[]
Yes
Current configuration item; configurable field list



Request Sample

{
    "Header": {},
    "Payload": {
        "VirtualmanTypeCode": "small_sample_2d",
        "AnchorCodes": [
            "wl_pink_skirt_suit_stand"
        ],
        "pageIndex": 1,
        "PageSize": 10
    }
}

Response Sample

{
    "Header": {
        "RequestID": "bj6ffacfae*****339214923249",
        "SessionID": "bj6ffacfae*****339214923250",
        "DialogID": "",
        "Code": 0,
        "Message": "ok"
    },
    "Payload": {
        "Total": 2,
        "Virtualmans": [
            {
                "ReferenceVideoSegmentUrl": "https://virtualhuman-cos-test-1251316161.cos.ap-nanjing.myqcloud.com/prod/resource-manager/small/57/159/4873/model_9331_20230921150529/pv.mp4",
                "VirtualmanKey": "xxx",
                "VirtualmanType": "2D Small Sample",
                "ExpireDate": "2024-06-25 15:23:15",
                "SupportDriverTypes": [
                    "Text",
                    "OriginalVoice",
                    "ModulatedVoice"
                ],
                "VirtualmanTypeCode": "small_sample_2d",
                "VideoDuration": 354458,
                "VideoNum": 19,
                "Resolution": "1080x1920",
                "AnchorName": "Misty Pink Skirt Suit",
                "PoseName": "Full body standing pose",
                "OriginZoom": "1.000",
                "HeaderImage": "https://virtualhuman-cos-test-1251316161.cos.ap-nanjing.myqcloud.com/prod/resource-manager/small/57/159/4873/model_9331_20230921150529/header.png",
                "PoseImage": "https://virtualhuman-cos-test-1251316161.cos.ap-nanjing.myqcloud.com/prod/resource-manager/small/57/159/4873/model_9331_20230921150529/preview.png",
                "ClothesImage": "https://virtualhuman-cos-test-1251316161.cos.ap-nanjing.myqcloud.com/virtualman-config/00e92768-3d23-40d7-aa39-94df36a44a38-Mask group pink skirt suit.png",
                "ClothesName": "Pink Skirt Suit",
                "AnchorCode": "wl_pink_skirt_suit_stand",
                "SupportAnchorExtraParams": [
                    {
                        "Key": "shirtColor",
                        "Description": "Shirt Color",
                        "Type": 1,
                        "Value": [
                            "colorValue"
                        ]
                    },
                    {
                        "Key": "clotheColor",
                        "Description": "Shirt Color",
                        "Type": 1,
                        "Value": [
                            "colorValue"
                        ]
                    }
                ]
            },
            {
                "ReferenceVideoSegmentUrl": "https://virtualhuman-cos-test-1251316161.cos.ap-nanjing.myqcloud.com/prod/resource-manager/small/57/159/4873/model_9331_20230921150529/pv.mp4",
                "VirtualmanKey": "xxx",
                "VirtualmanType": "2D Small Sample",
                "ExpireDate": "2024-06-25 15:23:15",
                "SupportDriverTypes": [
                    "Text",
                    "OriginalVoice",
                    "ModulatedVoice"
                ],
                "VirtualmanTypeCode": "small_sample_2d",
                "VideoDuration": 38880,
                "VideoNum": 1,
                "Resolution": "1920x1080",
                "AnchorName": "Misty Pink Skirt Suit",
                "PoseName": "Full body standing pose",
                "OriginZoom": "0.567",
                "HeaderImage": "https://virtualhuman-cos-test-1251316161.cos.ap-nanjing.myqcloud.com/prod/resource-manager/small/57/159/4873/model_9331_20230921150529/header.png",
                "PoseImage": "https://virtualhuman-cos-test-1251316161.cos.ap-nanjing.myqcloud.com/prod/resource-manager/small/57/159/4873/model_9331_20230921150529/preview.png",
                "ClothesImage": "https://virtualhuman-cos-test-1251316161.cos.ap-nanjing.myqcloud.com/virtualman-config/00e92768-3d23-40d7-aa39-94df36a44a38-Mask group pink skirt suit.png",
                "ClothesName": "Pink Skirt Suit",
                "AnchorCode": "wl_pink_skirt_suit_stand",
                "SupportAnchorExtraParams": []
            }
        ]
    }
}

Previous Topic: Querying Image Asset Information - Query AnchorNext Topic: Querying the List Of Actions Supported by the Avatar

Help and Support

Was this page helpful?

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

Feedback