- 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
API Description
Query all images under a specific anchor code, including all the anchor's clothing, poses, resolutions, and VirtualmanKeys.
Note:
This API is gradually being phased out. Use the Query Image Asset Information - Query all images under the anchor API for queries.
Calling Protocol
HTTPS + JSON
POST /v2/ivh/videomaker/broadcastservice/getresourcebyanchor
Header Content-Type: application/json;charset=utf-8
Request Parameters
Parameters | Type | Mandatory | Description |
GetAllResource | bool | Yes | When set to false, it retrieves resources specific to the current AppKey; when set to true, it retrieves all resources associated with the current user. |
AnchorCode | string | Yes | Anchor code, which can be obtained through the Customer Resource Query Anchor API |
Response Parameter
Parameters | Type | Mandatory | Description |
VirtualmanResources | Array of [VirtualmanResource] | Yes | Resources of the digital human within customers' permissions |
VirtualmanResource
Parameters | Type | Mandatory | Description |
AppKey | string | Yes | Requested AppKey |
Virtualmans | Array of [Virtualman] | Yes | Digital human under this role code |
Virtualman
Parameters | Type | Mandatory | Description |
VirtualmanKey | string | Yes | Define the broadcasting role, clothing, pose, and resolution. |
Name | string | Yes | Role name |
Code | string | Yes | Role 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 |
SupportAnchorExtraParams | Array if [SupportAnchorExtraParam] | Yes | Description of configurable parameters for the digital human avatars: Currently only 3D clothing color change parameters are included. |
OriginZoom | String type floating point number | Yes | Initial scaling factor of the digital human, accurate to three decimal places |
Request Sample
{"Header": {},"Payload": {"GetAllResource": true,"AnchorCode": "yani"}}
Response Sample
{"Header": {"Code": 0,"Message": "","RequestID": "123"},"Payload": {"VirtualmanResources": [{"AppKey": "22222","Virtualmans": [{"VirtualmanKey": "abddd","AnchorName": "Yani","AnchorCode": "yani","ClothesName": "Yellow Suit","PoseName": "Standing","Resolution": "1920x1080","HeaderImage": "url","PoseImage": "url","ClothesImage": "url","SupportDriverTypes": ["Text","OriginalVoice"],"SupportAnchorExtraParams": [{"Key": "shirtColor","Description": "Suit Color","Type": 1,"Value": ["colorValue"]},{"Key": "clotheColor","Description": "Shirt Color","Type": 1,"Value": ["colorValue"]}]}]}]}}
Yes
No
Was this page helpful?