文档

GetAvatar - 查询数字人

更新时间:

调用本接口,可以查询某个已经训练成功的数字人的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AvatarIdstring
  • 数字人 ID
Avatar-XXXX

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

******11-DB8D-4A9A-875B-275798******
Dataobject

响应数据

Avatarobject

数字人

AvatarIdstring

数字人 ID

Avatar-XXXX
AvatarNamestring

数字人名称

小数
AvatarDescriptionstring

数字人描述

这是一个数字人,用于某某场景。
AvatarTypestring

数字人类型

2DAvatar
Thumbnailstring

缩略图 URL

https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png
Portraitstring

头像图片媒资 ID

****571c704445f9a0ee011406c2****
Transparentboolean

用于标识当前数字人是否支持透明通道

true
Widthinteger

数字人形象的宽(单位:像素)

1080
Heightinteger

数字人形象的高(单位:像素)

1920
Successboolean

是否调用成功。

  • true:调用成功。
  • false:调用失败。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Data": {
    "Avatar": {
      "AvatarId": "Avatar-XXXX",
      "AvatarName": "小数",
      "AvatarDescription": "这是一个数字人,用于某某场景。",
      "AvatarType": "2DAvatar",
      "Thumbnail": "https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png",
      "Portrait": "****571c704445f9a0ee011406c2****",
      "Transparent": true,
      "Width": 1080,
      "Height": 1920
    }
  },
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-13OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈