- 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
This documentation primarily describes the API call methods on the Tencent Cloud AI Digital Human aPaaS platform, including permissions, common parameters, and signature requirements.
I. API Calling Environment
Official Environment: https://gw-sg.tvs.qq.com
II. Permission Application and Activation
The video generation aPaaS API usage permission can be obtained through the Asset Claim page, after which a 15-day trial permission will be activated.
III. Methods for Requesting Common Parameters and Signature
Common Parameters
When calling any API on aPaaS, you need to include the following common parameters in the URL as QueryString:
Parameter | Type | Mandatory | Description |
appkey | string | Yes | Fill in the appkey obtained after your permission application is approved. |
timestamp | string | Yes | Request timestamp in seconds. The timestamp cannot differ from the current time by more than five minutes, otherwise, authentication will fail. |
signature | string | Yes |
Signature Algorithm
Request Parameter Signature Steps are as follows:
1. The signature rules are as follows. An example is provided below (for reference only).
appkey = e38267c0e86411ebb02aed82acb0ed99accesstoken = f68f2d10ae9e4604b76fb05cf46bccecDomain Name Routing = https://gw.tvs.qq.com/v2/ivh/videomaker/broadcastservice/videomake
2. Sort all other parameters in the URL, except for the signature, in alphabetical order. Note that parameters in the body are not included. Currently, only the appkey and timestamp parameters are used. Therefore, the sorted and concatenated string example is:
appkey=e38267c0e86411ebb02aed82acb0ed99×tamp=1646636485
3. Use the accesstoken to perform HmacSha256 encryption on the signature string, and then encode it with base64.
hashBytes = HmacSha256("appkey=e38267c0e86411ebb02aed82acb0ed99×tamp=1646636485","f68f2d10ae9e4604b76fb05cf46bccec")signature = Base64Encode(hashBytes)
4. The obtained signature value is:
BfWuaC9kmaicCggXc693uK+sZQ8qe88O4HVQNTdwZuo=
5. Urlencode the signature value (this is mandatory, otherwise it may cause intermittent authentication failures), and then concatenate it to get the final request URL as follows:
https://gw.tvs.qq.com/v2/ivh/videomaker/broadcastservice/videomake?appkey=e38267c0e86411ebb02aed82acb0ed99×tamp=1646636485&signature=BfWuaC9kmaicCggXc693uK%2BsZQ8qe88O4HVQNTdwZuo%3D
IV. Request and Response Structure
Request Body Structure
The request body is divided into two parameters: Header and Payload. In the Header, you can include a RequestID to uniquely identify a request, which helps in system issue tracking. All business parameters should be placed in the Payload. For each API's input parameters, please refer to the respective product API documentation and place them in the Payload for transmission.
{"Header": {"RequestID": "",},"Payload": {}}
Response Body Structure
The response body is divided into two parameters: Header and Payload. The Header contains the result code, message, and the unique request ID which is the same as the value provided in the request body. The specific response parameters of the API will be placed in the Payload.
{"Header": {"Code": 0,"Message": "","RequestID": "", // If not filled in during the request, it will be generated and returned by the cloud},"Payload": {}}
Yes
No
Was this page helpful?