tencent cloud

All product documents
Tencent Cloud AI Digital Human
DocumentationTencent Cloud AI Digital HumanServer API IntegrationInteractive Digital Human Service API DocumentationOverview
Overview
Download PDF
Last updated: 2025-04-09 10:24:55
Overview
Last updated: 2025-04-09 10:24:55
Download PDF
This documentation primarily describes the open API protocol for the TCADH Interaction aPaas platform.

Must-Know

Before calling this API, please make sure you have purchased products related to the avatar.

API Calling Methods

When calling each API, you need to pass in common parameters and a signature in the query of the API. For an explanation of the parameters and signature methods, see the following link:


Interactive Digital Human API Overview

Function Category
API Title
No.
API
Description

Session Management
Create a session
1
POST /v2/ivh/sessionmanager/sessionmanagerservice/createsession
Create a session using the Digital Human Platform project and obtain the playback URL for the digital human video.

2
POST /v2/ivh/sessionmanager/sessionmanagerservice/createsessionbyasset
Use the authorized avatar asset to directly create a session and obtain the playback URL for the digital human video. For situations where no project has been created on the digital human platform.

3
POST /v2/ivh/sessionmanager/sessionmanagerservice/statsession
It is used to query the current status of a specified session.

4
POST /v2/ivh/sessionmanager/sessionmanagerservice/startsession
After the session is ready, this API must be called to proceed with driving.

9
POST /v2/ivh/sessionmanager/sessionmanagerservice/closesession
Close the session, stop the digital human streaming, and release concurrency.

Query session list
-
POST /v2/ivh/sessionmanager/sessionmanagerservice/listsessionofuin
Used for querying all ongoing conversation lists of a certain uin account.

-
POST /v2/ivh/sessionmanager/sessionmanagerservice/listsessionofprojectid
It is used to query all ongoing conversation lists under the Digital Human Project.

-
POST /v2/ivh/sessionmanager/sessionmanagerservice/listsessionofassetvk
It is used to query all ongoing conversation lists under the personal asset image.

Instruction-driven digital human

Note:
Instruction-driven application scenarios. See instruction-driven.
Persistent connection drive (WebSocket)
5
WSS /v2/ws/ivh/interactdriver/interactdriverservice/commandchannel
Create a websocket persistent connection channel to send drive instructions upstream and receive downstream messages.

6
-
After you establish a long connection channel, you can use a WebSocket persistent connection to send text to drive the digital human.

6
-
After establishing a persistent connection channel, you can send streaming text to drive the digital human through a websocket persistent connection.

6
-
After establishing a persistent connection channel, you can send audio to drive the digital human through a websocket persistent connection.

7
-
If the cloud does not receive any drive instructions for more than 10 minutes after that, the connection will be automatically disconnected and concurrency will be released. After creating a long connection channel, the session can be extended by sending heartbeat instructions. The sending interval is greater than 30 s and less than 10 minutes.

Direct drive (HTTPS)
8
POST /v2/ivh/interactdriver/interactdriverservice/command
Send text-driven instructions via HTTP method
Note:
No need to create a persistent connection channel, commonly used for trial use, one sentence drive and other scenarios.

Other APIs
-
POST /v2/ivh/sessionmanager/sessionmanagerservice/updatesessionconfig
It is used for real-time updating of the character's size, position, and background image in the video stream. This API is no longer recommended for use, and there will be no further iteration of new features.

-
POST /v2/ivh/sessionmanager/sessionmanagerservice/gettrtcsign
When a live session is created and the TRTC protocol is selected, this API is used by users other than the Digital Human to obtain the key for entering the room.


Access Process

Notes:
The serial number corresponding to that in the flowchart corresponds to the serial number in the API table above.


Process Description

Get the interactive digital human service by following the steps below:
1. Purchase related products and services: purchase link;
2. Create a session: Use one of the following two methods to create a session with the cloud, and obtain the session status and playback URL of the digital human video.
Create a session using the Digital Human Platform project
Create a session using the image asset
3. Wait for the stream to be ready: When the session status is preparing, it means the digital human model is loading. The duration generally does not exceed two minutes. By calling the Query Session Status API in a loop, wait until the session status is in progress. For the status code explanation of the session status, see Query Session Status.
4. Play video stream;
5. Start a session: After the video stream is ready, you need to call the start session API to enable the digital human to be driven by instructions.
6. Send drive instructions: For descriptions and requirements of various drive instructions, see instruction sending requirements.
7. Close a session: Please close the session after the interaction is completed.



Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon