Drive Digital Human By Audio
Description
Through this API, you can make the digital human play the specified input audio.
Request prototype
- Request method: POST
- Request body format: JSON
- Request URL: https://aigc-digitalhuman-api.zegotech.cn?Action=DriveByAudio
- Transmission protocol: HTTPS
- QPS limit: 10 times/second
Request Parameters
The following request parameter list only shows the API request parameters and some common parameters. For the complete list of common parameters, please refer to Accessing Server APIs - Common Request Parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
| TaskId | String | Yes | Digital human video stream task ID. You can obtain it from the response parameters of the CreateDigitalHumanStreamTask API. |
| AudioUrl | String | Yes | Audio URL link, supports MP3 and WAV files. |
| InterruptMode | Number | No | Whether to interrupt the running driving task and immediately execute this task. Optional values:
|
Sample request
-
Request URL:
https://aigc-digitalhuman-api.zegotech.cn?Action=DriveByAudio &<Common Request Parameters> -
Request body:
{ "TaskId": "xxx", "AudioUrl": "https://xxx.com/xxx.wav", "InterruptMode": 1 }
Response parameters
| Parameter | Type | Description |
|---|---|---|
| Code | Number | Return code. 0 indicates success, other values indicate failure. For error codes and response handling suggestions, please refer to Return Codes. |
| Message | String | Description of the request result. |
| RequestId | String | Request ID. |
| └DriveId | String | Digital human video stream driving task ID. |
Sample response
{
"Code": 0,
"Message": "success",
"RequestId": "e6f95291-7053-4c87-9bd0-b4b8c56aabfd",
"Data": {
"DriveId": "ae8c4d88-44fe-469a-aedf-df06849d0fdc"
}
}