- 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 anchors owned by customers within their permissions and anchor avatars through AppKey and AccessToken.
Note:
This API is gradually being phased out. Use the Query Image Asset Information - Query Anchor API for queries.
Calling Protocol
HTTPS + JSON
POST /v2/ivh/videomaker/broadcastservice/getanchor
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. |
VirtualmanTypeCode | string | No | Digital human type code: real_man_2d: 2D Premium Anchor real_man_3d: 3D Anchor |
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] | Resources of the digital human corresponding to this AppKey |
Virtualman
Parameters | Type | Mandatory | Description |
AnchorName | string | Yes | Anchor Name |
AnchorCode | string | Yes | Anchor Code |
HeaderImage | string | Yes | Digital human avatar image URL |
VirtualmanType | string | Yes | Digital human type |
VirtualmanTypeCode | string | Yes | Digital human type code |
Tag | string | Yes | Digital human model tags, categorized into three types: 1. Basic 2. Standard 3. Advanced Currently, the tag only affects the horizontal and vertical positioning of anchors. See the API Video Production API - Advanced Version. |
Request Sample
{"Header": {},"Payload": {"GetAllResource": true,"VirtualmanTypeCode": "real_man_2d"}}
Response Sample
{"Header": {"Code": 0,"Message": "","RequestID": "123"},"Payload": {"VirtualmanResources": [{"AppKey": "22222","Virtualmans": [{"AnchorName": "Yani","HeaderImage": "url","AnchorCode": "yani","VirtualmanTypeCode": "real_man_2d","VirtualmanType": "2D Real Person"}]}]}}
Yes
No
Was this page helpful?