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.
Parameter | Type | Required | Description |
---|---|---|---|
DigitalHumanId | String | Yes | Digital 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
Parameter | Type | Description |
---|---|---|
Code | Number | Return code. 0 indicates success, other values indicate failure. For error codes and response handling suggestions, please refer to Return Codes. |
Message | String | Description of the request result. |
RequestId | String | Request ID. |
Data | Object | Return data. |
└DigitalHumanId | String | Digital human ID. |
└Name | String | Digital human name. |
└AvatarUrl | String | Digital human image URL, valid for 24 hours. |
└IsPublic | Boolean | Whether it is a public digital human. |
└Actions | Array of Object | Digital human supported action list. For details, please refer to Action. |
Action
Parameter | Type | Description |
---|---|---|
Action | String | Action name. |
PreviewUrl | String | Action 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
}
}