Query Digital Human List

2026-03-20

Description

Through this API, you can obtain 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 includes API request parameters and some common parameters. For the complete list of common parameters, please refer to API Calling Methods - Common Request Parameters.

Parameter	Type	Required	Description
FetchMode	Number	No	Fetch mode: 1: Fetch all. 2: Fetch only public Digital Human list. 3: Fetch only private Digital Human list. If not specified, defaults to 1.
Offset	Number	No	Specifies the starting position for fetching, ranging from [0, 1000000]. If not specified, defaults to 0. If the value is less than 0 or greater than 1000000, the API call will return an error.
Limit	Number	No	Number of Digital Human entries to fetch. Ranges from [1, 20]. If not specified, defaults to 20. If the value is less than 1 or greater than 20, the API call will return an error.

Request Example

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 recommendations, please refer to Return Codes.
Message	String	Description of the request result.
RequestId	String	Request ID.
Data	Object	Response data.
└Total	Number	Total number of Digital Humans matching the query conditions.
└DigitalHumans	Array of Object	Digital Human list. For details, refer to DigitalHuman.

DigitalHuman

Parameter	Type	Description
DigitalHumanId	String	Digital Human ID.
Name	String	Digital Human name.
AvatarUrl	String	Digital Human image URL. The access validity period is 24 hours.
IsPublic	Boolean	Whether it is a public avatar: true: Public avatar. false: Private avatar.
Actions	Array of Object	List of actions supported by the Digital Human.
└Action	String	Action name.
└PreviewUrl	String	Action preview video URL.

Response Example

{
    "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
            }
        ]
    }
}