On this page

Drive Digital Human with Audio

2026-03-20

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.

ParameterTypeRequiredDescription
TaskIdStringYesDigital Human video stream task ID. Obtained from the response parameter of the Create Digital Human Video Stream Task API.
AudioUrlStringYesAudio URL link. Supports MP3 and WAV files.
InterruptModeNumberNoWhether 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.

Request Example

  • 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

ParameterTypeDescription
CodeNumberReturn code. 0 indicates success, other values indicate failure. For error codes and response handling recommendations, please refer to Return Codes.
MessageStringDescription of the request result.
RequestIdStringRequest ID.
└DriveIdStringDigital 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"
    }
}

Previous

Drive Digital Human via WebSocket

Next

Drive Digital Human with Text

On this page

Back to top