Query Digital Human
Updated: 2026-07-13 11:57:31
API Description
1、查询数字人列表
2、接口支持https协议
API URL
http://api.polyv.net/live/v4/ai/digital-human/list
Request Method
GET
API Constraints
- The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls are subject to rate limits. See details
Request Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | true | String | Account appId See details on obtaining the key |
| timestamp | true | Long | Current 13-digit millisecond timestamp, valid within 3 minutes |
| pageNumber | true | Integer | Pagination parameter, page number |
| pageSize | true | Integer | Pagination parameter, number of items per page, maximum 1000 |
| sign | true | String | Signature, a 32-character uppercase MD5 value. The appSecret key used to generate the signature is critical for communication data security. It must never be saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server and obtain response data. See signature generation rules |
Example
http://api.polyv.net/live/v4/ai/digital-human/list?timestamp=1716105057233&appId=gopl67qi7e&pageNumber=1&pageSize=10&sign=7AFFB910696C8657BB2E27ED6162CA5C
Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Response status code, 200 for success, non-200 for failure |
| status | String | Response result, determined by business logic, returns success on success, error on failure |
| success | Boolean | Response result, determined by business logic, returns true on success, false on failure |
| data | Object | Returns detailed channel information on successful response See data field description |
| error | Object | Error information when status code is non-200 See Error field description |
| requestId | String | Request ID, a unique UUID generated for each request, only for troubleshooting and debugging, should not be tied to business logic |
data Parameter Description
| Parameter | Type | Description |
|---|---|---|
| pageNumber | Integer | Pagination parameter, page number |
| pageSize | Integer | Pagination parameter, number of items per page |
| totalPages | Integer | Pagination parameter, total number of pages |
| totalItems | Integer | Pagination parameter, total number of items |
| contents | List | Digital human details See contents parameter description |
contents Parameter Description
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Digital human ID |
| name | String | Digital human name |
| thirdRoleCode | String | Digital human model ID |
| coverPhoto | String | Digital human cover image |
| fullBodyPhoto | String | Digital human actual image |
| clothesDesc | String | Digital human clothing |
| defaultTtsVoiceId | Integer | Default voice ID used by the digital human |
| createTime | Long | Digital human creation time, 13-digit timestamp |
Response Example
Success Example
{
"code": 200,
"status": "success",
"requestId": "e90aba2c69a24bab894c7f708b853b75.72.17161057275927183",
"data": {
"pageNumber": 1,
"pageSize": 2,
"totalPages": 8,
"totalItems": 16,
"contents": [
{
"id": 55,
"name": "萌萌",
"thirdRoleCode": "00024",
"coverPhoto": "https://img.videocc.net/e5f34f7744/html/adv/wav/00024-cover.png",
"fullBodyPhoto": "https://img.videocc.net/e5f34f7744/html/adv/wav/00024.png",
"defaultTtsVoiceId": 92,
"clothesDesc": "白色西装",
"createTime": 1704191006000
},
{
"id": 13,
"name": "花花",
"thirdRoleCode": "00006",
"coverPhoto": "https://img.videocc.net/e5f34f7744/html/adv/wav/00006-cover.png",
"fullBodyPhoto": "https://img.videocc.net/e5f34f7744/html/adv/wav/00006.png",
"defaultTtsVoiceId": 28,
"clothesDesc": "黑色西服",
"createTime": 1694569468000
}
]
},
"success": true
}
Error Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Error code, used to determine the specific error |
| desc | String | Error description, corresponds to error.code |
