- Product Overview
- Purchase Guide
- Introduction of Avatar
- Server API Integration
- Avatar aPaas API Calling Methods
- Avatar Image Customization and Voice Clone API Documentation - v 0.2.1
- Video Generation Service API Documentation - v 4.9.9
- Overview
- Digital Human aPaaS API Calling Methods
- Audio Production API
- Video Production API - Basic Edition
- Audio and Video Production Progress Query API
- Video Production API - Advanced Version
- Customer Resource Query Anchor API
- Querying All Images of a Specific Anchor
- Querying the Supported Timbres for VirtualmanKey (to Be Deprecated)
- Querying the Supported Actions for VirtualmanKey
- Appendix
- API Integration FAQs
- Interactive Digital Human Service API Documentation - v 5.0.3
- Overview
- Digital Human aPaaS API Calling Methods
- Live Session Management
- Creating a New Live Stream Session
- Using the Personal Asset Image to Create a Stream
- Querying the Session Status
- Starting Session
- Closing Live Session
- Querying the Conversation List under the Digital Human Project
- Querying the Conversion List under the Personal Asset Image
- Querying the Session List under UIN
- Instruction-driven
- Other APIs
- Error Code Description
- Best Practices demo
- Personal Asset Management API Documentation - v 1.1.2
- Overview
- Digital Human aPaaS API Calling Methods
- Querying for Avatar List by Pagination API
- Querying Supported Timbres for Avatars (to be Deprecated)
- Querying Customer Service Asset Information
- Querying Timbre Lists by Pagination
- Querying Image Asset Information - Query Anchor
- Querying Image Asset Information - Querying all Avatars under the Anchor
- Querying the List Of Actions Supported by the Avatar
- Appendix 1 - Service Asset Type
- Appendix 2 - Emotional Style
- Appendix 3 - Digital Human Type
- API Integration FAQs
- Client SDK Integration
- TCADH Platform Operation Guide
- FAQs
- Product Overview
- Purchase Guide
- Introduction of Avatar
- Server API Integration
- Avatar aPaas API Calling Methods
- Avatar Image Customization and Voice Clone API Documentation - v 0.2.1
- Video Generation Service API Documentation - v 4.9.9
- Overview
- Digital Human aPaaS API Calling Methods
- Audio Production API
- Video Production API - Basic Edition
- Audio and Video Production Progress Query API
- Video Production API - Advanced Version
- Customer Resource Query Anchor API
- Querying All Images of a Specific Anchor
- Querying the Supported Timbres for VirtualmanKey (to Be Deprecated)
- Querying the Supported Actions for VirtualmanKey
- Appendix
- API Integration FAQs
- Interactive Digital Human Service API Documentation - v 5.0.3
- Overview
- Digital Human aPaaS API Calling Methods
- Live Session Management
- Creating a New Live Stream Session
- Using the Personal Asset Image to Create a Stream
- Querying the Session Status
- Starting Session
- Closing Live Session
- Querying the Conversation List under the Digital Human Project
- Querying the Conversion List under the Personal Asset Image
- Querying the Session List under UIN
- Instruction-driven
- Other APIs
- Error Code Description
- Best Practices demo
- Personal Asset Management API Documentation - v 1.1.2
- Overview
- Digital Human aPaaS API Calling Methods
- Querying for Avatar List by Pagination API
- Querying Supported Timbres for Avatars (to be Deprecated)
- Querying Customer Service Asset Information
- Querying Timbre Lists by Pagination
- Querying Image Asset Information - Query Anchor
- Querying Image Asset Information - Querying all Avatars under the Anchor
- Querying the List Of Actions Supported by the Avatar
- Appendix 1 - Service Asset Type
- Appendix 2 - Emotional Style
- Appendix 3 - Digital Human Type
- API Integration FAQs
- Client SDK Integration
- TCADH Platform Operation Guide
- FAQs
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}}
Yes
No
Was this page helpful?