Drive Digital Human with Audio

2026-08-03

Description

Through this API, you can make the Digital Human broadcast the specified input audio. Audio drive requires you to pre-generate audio files. You can drive the Digital Human by uploading an audio file, and the Digital Human's speech timbre and content entirely depend on your audio file.

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 includes API request parameters and some common parameters. For the complete list of common parameters, please refer to API Calling Methods - Common Request Parameters.

Parameter	Type	Required	Description
TaskId	String	Yes	Digital Human video stream task ID. Obtained from the response parameter of the Create Digital Human Video Stream Task API.
AudioUrl	String	Yes	Audio URL link. Supports MP3 and WAV files.
InterruptMode	Number	No	Whether to interrupt the currently executing broadcast task and immediately execute this task. Options: 0 (default): No, queue and wait for the previous task to complete before executing. 1: Yes, immediately interrupt the current task and execute this task.
VoiceChannel	Number	No	The channel where the voice is located. When the input audio is a dual-channel audio file and the voice is only in one of the channels, use this parameter to specify which channel contains the voice, and the system will automatically extract the voice from that channel to drive the Digital Human. Default value: 0. Options: 0: Mixed (voice mixed in both left and right channels) 1: Left channel 2: Right channel

Request Example

Request URL:

https://aigc-digitalhuman-api.zegotech.cn?Action=DriveByAudio
&<common-request-parameters>

https://aigc-digitalhuman-api.zegotech.cn?Action=DriveByAudio
&<common-request-parameters>

Request body:

{
    "TaskId": "xxx",
    "AudioUrl": "https://xxx.com/xxx.wav",
    "InterruptMode": 1
}

{
    "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 recommendations, please refer to Return Codes.
Message	String	Description of the request result.
RequestId	String	Request ID.
└DriveId	String	Digital Human video stream drive task ID.

Response Example

{
    "Code": 0,
    "Message": "success",
    "RequestId": "e6f95291-7053-4c87-9bd0-b4b8c56aabfd",
    "Data": {
        "DriveId": "ae8c4d88-44fe-469a-aedf-df06849d0fdc"
    }
}

{
    "Code": 0,
    "Message": "success",
    "RequestId": "e6f95291-7053-4c87-9bd0-b4b8c56aabfd",
    "Data": {
        "DriveId": "ae8c4d88-44fe-469a-aedf-df06849d0fdc"
    }
}