- Product Overview
- 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
- 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
- FAQs
- Product Overview
- 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
- 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
- FAQs
API Description
To preview the input text, you can query the timbre to be previewed through the Query Supported Timbres for VirtualmanKey API. Some avatars do not support changing the timbre.
Calling Protocol
HTTPS + JSON
POST /v2/ivh/videomaker/broadcastservice/tts
Header Content-Type: application/json;charset=utf-8
Request Parameters
Parameters | Type | Mandatory | Description |
TimbreKey | string | No | Timbre key. When VirtualmanKey is empty, TimbreKey cannot be empty. |
VirtualmanKey | string | No | Define information such as the role, clothing, pose, and resolution for the broadcast. The parameter is an enumerated value. When TimbreKey is empty, VirtualmanKey cannot be empty. By default, the first matching timbre for the avatar will be selected to produce the audio. |
InputSsml | string | Yes | Text content to be broadcast which supports SSML tags with an upper limit of 20,000 characters (counted as Unicode characters) |
Speed | float | Yes | Speech rate (1.0 is normal speed, with a range of [0.5 to 1.5]. A value of 0.5 represents the slowest speed, while 1.5 represents the fastest speed). |
AudioStorageS3Url | string | No | A URL with an authenticated S3 protocol for storage can be provided, and the finished audio will be uploaded to that URL. |
SampleRate | int | No | Sample rate which supports 24000 (24k) and 16000 (16k) with 24000 (24k) as the default |
Codec | string | No | Audio format which supports mp3 and wav with mp3 as the default |
SentenceMaxWords | int | No | The upper limit number of characters per sentence which ranges from 0 to 999. If 0 or nothing is provided, the default value is 30. |
SentenceDisplayPunctuation | string | No | Punctuation marks to be displayed within sentences. Special character "0" means that no punctuation marks will be displayed, while "1" (default value) means that all punctuation marks will be displayed. You can also customize which punctuation marks to display. |
SentenceSplitPunctuation | string | No | Punctuation marks for sentence segmentation with the default values being . ; ?! ... !? |
Volume | int | No | Volume level, ranging from 0 to 10. The default is 0, which represents normal volume. The higher the values, the louder the volume. |
EmotionCategory | string | No | Control the emotion of synthetic audio, and only multi-emotion timbres are supported for the use. See the Personal Asset Management API 4.5 Timbre List API for optional values. |
EmotionIntensity | int | No | Controls the intensity of the synthesized audio emotion, with a range of [50,200]. This is only effective when EmotionCategory is not empty. |
Response Parameter
Parameters | Type | Mandatory | Description |
TaskId | string | Yes | The task ID for audio production. Use the taskId to access the <Audio and Video Production Progress Query API> to obtain the production progress and download link for the video. |
Request Sample
{"Header": {},"Payload": {"VirtualmanKey": "123","InputSsml": "Hello, virtual anchor","Speed": 1}}
Response Sample
{"Header": {"Code": 0,"DialogID": "","Message": "","RequestID": "123"},"Payload": {"TaskId": "123"}}
Yes
No
Was this page helpful?