On this page

Interrupt Digital Human Video Stream Drive Task

2026-03-20

Description

Through this API, you can interrupt the Digital Human's currently ongoing video stream drive task.

Note

Interrupts the Digital Human's currently ongoing broadcast task and discards all queued broadcast tasks.

Request prototype

  • Request method: POST
  • Request body format: JSON
  • Request URL: https://aigc-digitalhuman-api.zegotech.cn?Action=InterruptDriveTask
  • 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.

Request Example

  • Request URL:

    https://aigc-digitalhuman-api.zegotech.cn?Action=InterruptDriveTask
    &<common-request-parameters>
  • Request body:

    {
        "TaskId": "f06d1f5d-c0d1-4845-9a2c-f0a45ee037fd"
    }

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.

Response Example

{
    "Code": 0,
    "Message": "success",
    "RequestId": "e6f95291-7053-4c87-9bd0-b4b8c56aabfd"
}

Previous

Query Running Digital Human Video Stream Tasks

Next

Stop Digital Human Video Stream Task

On this page

Back to top