Query Digital Human List

Description

Through this API, you can retrieve the list of available digital humans.

Request prototype

Request method: POST
Request body format: JSON
Request URL: https://aigc-digitalhuman-api.zegotech.cn?Action=GetDigitalHumanList
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
InferenceMode	Number	No	Inference mode: 1: Normal inference. 2: Advanced inference. Retrieve the list of digital humans that support the corresponding inference mode. If not specified, the default value is 1.
FetchMode	Number	No	Fetch mode: 1: Full fetch. 2: Only fetch public digital human list. 3: Only fetch private digital human list. If not specified, the default value is 1.
Offset	Number	No	Indicates from which record to start fetching, with a range of [0, 1000000]. If not specified, the default value is 0. If the value is less than 0 or greater than 1000000, the API call will fail.
Limit	Number	No	Number of digital human records to fetch. Range is [1, 20]. If not specified, the default value is 20. If the value is less than 1 or greater than 20, the API call will fail.

Sample request

Request URL:

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

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

Request body:

{
    "FetchMode": 1,
    "Offset": 0,
    "Limit": 10
}

{
    "FetchMode": 1,
    "Offset": 0,
    "Limit": 10
}

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.
└Total	Number	Total number of digital humans matching the query criteria.
└DigitalHumans	Array of Object	Digital human list. For details, please refer to DigitalHuman.

DigitalHuman

Parameter	Type	Description
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: true: Public digital human. false: Private digital human.
Actions	Array of Object	List of actions supported by the digital human.
└Action	String	Action name.
└PreviewUrl	String	Action preview video URL.

Sample response

{
    "Code": 0,
    "Message": "success",
    "RequestId": "aa62cf9f-2797-4bd0-9cbf-e461b82d75a5",
    "Data": {
        "Total": 1,
        "DigitalHumans": [
            {
                "DigitalHumanId": "077f52b8-1513-49f8-af14-54a57dadda2e",
                "Name": "xxx",
                "AvatarUrl": "https://xxx.com/xxx.png",
                "Actions": [],
                "IsPublic": false
            }
        ]
    }
}

{
    "Code": 0,
    "Message": "success",
    "RequestId": "aa62cf9f-2797-4bd0-9cbf-e461b82d75a5",
    "Data": {
        "Total": 1,
        "DigitalHumans": [
            {
                "DigitalHumanId": "077f52b8-1513-49f8-af14-54a57dadda2e",
                "Name": "xxx",
                "AvatarUrl": "https://xxx.com/xxx.png",
                "Actions": [],
                "IsPublic": false
            }
        ]
    }
}