logo
On this page

Query Digital Human Details


Description

Through this API, you can retrieve the detailed information of a digital human.

Request prototype

  • Request method: POST
  • Request body format: JSON
  • Request URL: https://aigc-digitalhuman-api.zegotech.cn?Action=GetDigitalHumanInfo
  • 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
DigitalHumanIdStringYesDigital human ID. You can obtain it from the response of the GetDigitalHumanList API.

Sample request

  • Request URL:

    https://aigc-digitalhuman-api.zegotech.cn?Action=GetDigitalHumanInfo
    &<Common Request Parameters>
  • Request body:

    {
        "DigitalHumanId": "fa592895-d988-4584-b27b-97b8f4b921ad"
    }

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.
DataObjectReturn data.
└DigitalHumanIdStringDigital human ID.
└NameStringDigital human name.
└AvatarUrlStringDigital human image URL, valid for 24 hours.
└IsPublicBooleanWhether it is a public digital human.
└ActionsArray of ObjectDigital human supported action list. For details, please refer to Action.

Action

ParameterTypeDescription
ActionStringAction name.
PreviewUrlStringAction preview video URL.

Sample response

{
    "Code": 0,
    "Message": "success",
    "RequestId": "52ef286e-0ee5-4cbb-ba93-45c4f89c5d00",
    "Data": {
        "DigitalHumanId": "fa592895-d988-4584-b27b-97b8f4b921ad",
        "Name": "xxx",
        "AvatarUrl": "https://xxx.com/xxx.png",
        "Actions": [
            {
                "Action": "802_921474",
                "PreviewUrl": "https://xxx.com/preview/xxx/xxx.mp4"
            },
            {
                "Action": "790_421367",
                "PreviewUrl": "https://xxx.com/preview/xxx/xxx.mp4"
            },
            {
                "Action": "804_750085",
                "PreviewUrl": "https://xxx.com/preview/xxx/xxx.mp4"
            },
            {
                "Action": "idle_action",
                "PreviewUrl": "https://xxx.com/preview/xxx/xxx.mp4"
            },
            {
                "Action": "mute_action",
                "PreviewUrl": "https://xxx.com/preview/xxx/xxx.mp4"
            }
        ],
        "IsPublic": true
    }
}

Previous

Query Digital Human List

Next

Query Timbre List