logo
On this page

Interrupt Digital Human Video Stream Drive Task


Description

Through this API, you can interrupt the digital human video stream drive task that is currently running.

Note

The API not only interrupts the current digital human video stream drive task, but also discards the queued driving 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 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.

ParameterTypeRequiredDescription
TaskIdStringYesDigital human video stream task ID. You can obtain it from the response parameters of the CreateDigitalHumanStreamTask API.

Sample request

  • 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 suggestions, please refer to Return Codes.
MessageStringDescription of the request result.
RequestIdStringRequest ID.

Sample response

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

Previous

Get Digital Human Video Stream Drive Task Status

Next

Query Running Digital Human Video Stream Tasks