创建资产
功能介绍
该接口用于在资产库中添加上传新的媒体资产。可上传的资产类型包括:分身数字人模型、背景图片、素材图片、素材视频、PPT等。
-
资产类型是IMAGE时,通过system_properties来区分背景图片(BACKGROUND_IMG)、素材图片(MATERIAL_IMG)。
-
资产类型是VIDEO时,通过system_properties来区分素材视频(MATERIAL_VIDEO)、名片视频(BUSSINESS_CARD_VIDEO)。
-
MetaStudio平台生成的视频,system_properties带CREATED_BY_PLATFORM。
接口约束
-
不同资产类型主文件格式与大小约束如下
视频资产:资产类型为VIDEO,主文件格式(忽略大小写)为mp4、m4v、mkv、mov、flv、3gp、wmv、avi、webm,主文件大小不超过5G
图片资产:资产类型为IMAGE,主文件格式(忽略大小写)为jpeg、jpg、png、bmp、gif,主文件大小不超过50M
背景音乐资产:资产类型为MUSIC,主文件格式(忽略大小写)为wav,mp3,m4a,主文件大小不超过100M
音频资产:资产类型为AUDIO,主文件格式(忽略大小写)为wav,mp3,m4a,主文件大小不超过100M
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/digital-assets
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 格式为(YYYYMMDD'T'HHMMSS'Z')。 |
X-App-UserId |
否 |
String |
第三方用户ID。不允许输入中文。 |
X-MSS-Authorization |
否 |
String |
数字人内部token |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
asset_name |
是 |
String |
参数解释: 资产名称。 约束限制: 不涉及。 取值范围: 只能使用中英文字符,字符长度0-256位。 默认取值: 不涉及。 |
asset_description |
否 |
String |
参数解释: 资产描述。 约束限制: 不涉及。 取值范围: 只能使用中英文字符,字符长度0-4096位。 默认取值: 不涉及。 |
asset_type |
是 |
String |
参数解释: 资产类型。 约束限制: VOICE_MODEL,HUMAN_MODEL_2D 普通用户均无法上传。 取值范围: 公共资产类型:
分身数字人资产:
3D数字人资产:
默认取值: 不涉及。 |
review_config |
否 |
ReviewConfig object |
内容审核配置。 |
tags |
否 |
Array of strings |
参数解释: 标签列表。
说明:
分身形象系统资产的tag定义如下:
约束限制: 不涉及 取值范围: 标签个数最大为50个。 标签内容为中英文,字符长度0-128位。 默认取值: 不涉及 |
asset_extra_meta |
否 |
AssetExtraMeta object |
参数解释: 资产额外元数据。 约束限制: 根据asset_type选择对应结构填写,填写其他不匹配的结构会被忽略。
|
system_properties |
否 |
Array of SystemProperty objects |
参数解释: 设置系统属性。内部参数,普通用户无需设置。 约束限制: 不涉及 取值范围: 个数最大为50个。 默认取值: 不涉及 |
shared_config |
否 |
AssetSharedConfig object |
参数解释: 资产共享配置。 约束限制: 当前仅用于直播模板分享连带的资产共享。 取值范围: 不涉及 默认取值: 不涉及 |
is_need_generate_cover |
否 |
Boolean |
参数解释: 是否需要生成封面。 约束限制: 仅用于视频类资产。 取值范围:
默认取值: false |
asset_order |
否 |
Integer |
参数解释: 用于console控制台展示顺序。 如果取值相同,则默认最新的排在前面。 约束限制: 不涉及 默认取值: 不涉及 取值范围: 0-32767 |
supported_service |
否 |
Array of strings |
支持的业务类型。:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
human_model_meta |
否 |
HumanModelAssetMeta object |
数字人模型元数据。 |
voice_model_meta |
否 |
VoiceModelAssetMeta object |
音色模型元数据。 |
ppt_meta |
否 |
PPTAssetMeta object |
PPT资产元数据信息。 |
animation_meta |
否 |
AnimationAssetMeta object |
动作动画资产元数据。 |
scene_meta |
否 |
SceneAssetMeta object |
场景元数据。 |
material_meta |
否 |
MaterialAssetMeta object |
素材元数据。 |
human_model_2d_meta |
否 |
HumanModel2DAssetMeta object |
分身模型元数据 |
image_meta |
否 |
ImageAssetMeta object |
图片元数据 |
video_meta |
否 |
VideoAssetMeta object |
视频元数据,自动提取获得。 |
audio_meta |
否 |
AudioAssetMeta object |
音频元数据,自动提取获得。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
style_id |
否 |
String |
参数解释: 数字人模型风格ID。 约束限制: 当前仅支持系统提供的几种风格。 取值范围:
默认取值: 不涉及 |
modeling_type |
否 |
String |
参数解释: 数字人模型建模类型。 约束限制: 不涉及 取值范围:
默认取值: UPLOADED |
modeling_job_id |
否 |
String |
参数解释: 建模任务ID。 约束限制: 仅由MetaStudio服务生成的模型系统自行填写 取值范围: 字符长度0-64位。 默认取值: 不涉及。 |
model_properties |
否 |
HumanModelMetaProperties object |
记录模型配置信息 |
components |
否 |
Array of ComponentInfo objects |
可替换组件列表。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
whole_model_base_file_id |
否 |
String |
参数解释: 用于生成WHOLE_MODEL的模型file_id 约束限制: 如果当前记录的信息与MAIN文件的file_id一致,那就认为已经生成过,无需再进行全模型导出 取值范围: 字符长度0-64位。 默认取值: 不涉及。 |
load_model_file_id |
否 |
String |
参数解释: 当前用于渲染加载的模型file_id 约束限制: 若为空或未匹配到,则使用MAIN文件 取值范围: 字符长度0-64位。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
component_name |
是 |
String |
参数解释: 组件名称。 约束限制: 不涉及。 取值范围: 字符长度1-256位。 默认取值: 不涉及。 |
component_type |
是 |
String |
参数解释: 组件类型。 约束限制: 不涉及。 取值范围: 字符长度1-256位。 默认取值: 不涉及。 |
component_desc |
否 |
String |
参数解释: 组件描述。 约束限制: 不涉及。 取值范围: 字符长度0-512位。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
order |
否 |
Integer |
参数解释: 展示顺序。 约束限制: 不涉及。 取值范围: 0-32767 默认取值: 999 |
model_type |
否 |
String |
参数解释: 声音资产类型。 约束限制: 不涉及。 取值范围:
默认取值: CLONE |
sex |
否 |
String |
参数解释: 声音性别。 约束限制: 不涉及。 取值范围:
默认取值: UNKNOW |
language |
否 |
String |
参数解释: 声音语言。 约束限制: 不涉及。 取值范围:
默认取值: UNKNOW |
languages |
否 |
Array of strings |
参数解释: 声音语言。 约束限制: 不涉及。 取值范围:
|
speed_ratio |
否 |
Float |
参数解释: 语速缩放比例。 约束限制: 不涉及 取值范围: 0-100 默认取值: 1 |
volume_ratio |
否 |
Float |
参数解释: 音量缩放比例。 约束限制: 不涉及 取值范围: 0-100 默认取值: 1 |
is_realtime_voice |
否 |
Boolean |
参数解释: 该音色是否支持实时合成。 约束限制: 支持实时合成的音色,可以用于直播和智能交互场景。否则只能用于视频制作。 取值范围:
默认取值: true |
style |
否 |
String |
风格参考 |
external_voice_meta |
否 |
ExternalVoiceAssetMeta object |
第三方TTS音色元数据。 |
is_support_vc_process |
否 |
Boolean |
是否支持vc。 默认取值: false |
is_flexus |
否 |
Boolean |
是否是Flexus版本声音。 默认取值: false |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
provider |
是 |
String |
第三方TTS供应商类型。
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
auto_analysis |
否 |
Boolean |
参数解释: PPT是否需要自动解析。 约束限制: 部分过于复杂的PPT或压缩比过高的PPT可能无法解析。 超过50页PPT仅转换50页 转换的图片无法保证完全还原,需要自行确认。 取值范围:
默认取值: false |
ppt_analysis_status |
否 |
String |
参数解释: PPT解析状态。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
error_info |
否 |
ErrorResponse object |
错误信息 |
page_count |
否 |
Integer |
参数解释: PPT页面总数。 约束限制: 不涉及 取值范围: 0-256 默认取值: 0 |
pages |
否 |
Array of PPTPageInfo objects |
PPT页面图片。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
page_no |
否 |
Integer |
参数解释: 页面编号。 约束限制: 不涉及 取值范围: 1-256 |
file_id |
否 |
String |
参数解释: 页面对应图片文件ID。 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
page_content |
否 |
String |
参数解释: 页面对应图片文件ID 约束限制: 不涉及 取值范围: 字符长度0-2048位 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
style_id |
否 |
String |
数字人模型风格ID。 |
duration |
否 |
Float |
动作动画时长。 取值范围: 0-32767 默认取值: 0 |
auto_analysis |
否 |
Boolean |
动作是否需要自动解析。 默认取值: false |
voice_delay |
否 |
Float |
语音延迟播放时长。 单位秒。 使用场景举例:入场动画3秒,voice_delay设置成4秒,则语音从入场动画开始后第4秒开始播放。 取值范围: 0-100 默认取值: 0 |
animation_insert_restriction |
否 |
String |
动画插入位置限制。
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
components |
否 |
Array of SceneComponentInfo objects |
可操作组件列表(如屏幕,灯光,摄像机)。 |
default_configs |
否 |
Map<String,SceneComponentInfo> |
默认场景设置(机位,初始人位置)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
index |
否 |
Integer |
组件索引。 取值范围: 1-10 |
component_name |
是 |
String |
组件名称。 |
component_type |
是 |
String |
组件类型。
|
component_desc |
否 |
String |
组件描述。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
components |
否 |
Array of MaterialComponentInfo objects |
可替换的素材组件列表。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
component_name |
是 |
String |
素材组件名称。 |
component_type |
是 |
String |
素材组件类型。
|
component_desc |
否 |
String |
素材组件描述。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
is_action_editable |
否 |
Boolean |
参数解释: 分身数字人的动作是否可编辑 约束限制: 不涉及 取值范围:
默认取值: false |
is_real_background |
否 |
Boolean |
参数解释: 是否是实景分身数字人 约束限制: 实景分身数字人不做背景替换。 取值范围:
默认取值: false |
support_live |
否 |
Boolean |
参数解释: 是否支持直播 约束限制: 不涉及 取值范围:
默认取值: false |
model_version |
否 |
String |
参数解释: 分身数字人模型版本 约束限制: 不涉及 取值范围:
默认取值: V2 |
model_resolution |
否 |
String |
参数解释: 分身数字人模型分辨率。 约束限制: 不涉及 取值范围:
默认取值: 1080P |
device_names |
否 |
Array of strings |
参数解释: 已执行编译任务设备类型列表。 约束限制: 支持走动的数字人,当前仅用于视频制作,不能用于直播和智能交互 取值范围: 设备名称列表最多16个。 设备名称字符长度1-64位。 默认取值: false |
is_with_action_library |
否 |
Boolean |
分身数字人是否带原子动作库。
说明:
默认取值: false |
action_tag_map |
否 |
Array of ActionTagInfo objects |
动作标签映射。 |
is_flexus |
否 |
Boolean |
是否是Flexus版本分身数字人。 默认取值: false |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action_name_zh |
是 |
String |
原子动作中文名称。 |
action_name_en |
是 |
String |
原子动作英文名称。 |
catalog |
否 |
String |
动作分类名称。 |
file_name |
否 |
String |
样例视频文件名,最大长度256,最小长度1。 |
tag |
否 |
String |
动作标签。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
codec |
否 |
String |
参数解释: 图片编码格式。 约束限制: 用户无需填写,系统自行提取。 取值范围: 字符长度0-32位。 默认取值: 不涉及。 |
width |
否 |
Integer |
参数解释: 图片宽度。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及。 取值范围: 0-8196 |
height |
否 |
Integer |
参数解释: 图片高度。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及。 取值范围: 0-8196 |
size |
否 |
Long |
参数解释: 图片大小。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及。 取值范围: 0-9223372036854775807 |
mode |
否 |
String |
参数解释: 图片形态。 约束限制: 用户无需填写,系统自行提取。 取值范围:
默认取值: 不涉及。 |
frame_rate |
否 |
String |
参数解释: 视频帧率。 约束限制: 用户无需填写,系统自行提取。 取值范围: 字符长度0-32位。 默认取值: 不涉及 |
duration |
否 |
Integer |
参数解释: 时长,单位秒。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及 取值范围: 0-86400 |
error_info |
否 |
ErrorResponse object |
错误信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
video_codec |
否 |
String |
参数解释: 视频编码格式。 约束限制: 用户无需填写,系统自行提取。 取值范围: 字符长度0-32位。 默认取值: 不涉及 |
width |
否 |
Integer |
参数解释: 视频画面宽度。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及 取值范围: 0-8196 |
height |
否 |
Integer |
参数解释: 视频画面高度。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及 取值范围: 0-8196 |
frame_rate |
否 |
String |
参数解释: 视频帧率。 约束限制: 用户无需填写,系统自行提取。 取值范围: 字符长度0-32位。 默认取值: 不涉及 |
video_bit_rate |
否 |
Integer |
参数解释: 视频平均码率,单位kbps。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及 取值范围: 0-104857600 |
duration |
否 |
Integer |
参数解释: 时长,单位秒。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及 取值范围: 0-86400 |
audio_codec |
否 |
String |
参数解释: 音频编码格式。 约束限制: 用户无需填写,系统自行提取。 取值范围: 字符长度0-32位。 默认取值: 不涉及 |
audio_bit_rate |
否 |
Integer |
参数解释: 音频平均码率,单位kbps。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及 取值范围: 0-16384 |
audio_channels |
否 |
Integer |
参数解释: 音频声道数。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及 取值范围: 0-100 |
sample |
否 |
Integer |
参数解释: 采样率,HZ。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及 取值范围: 0-100000 |
mode |
否 |
String |
参数解释: 横向画面或纵向画面。 约束限制: 用户无需填写,系统自行提取。 取值范围:
默认取值: 不涉及 |
video_transcoding_status |
否 |
String |
参数解释: 视频转码状态。 约束限制: 用户无需填写,系统自行填写。 取值范围:
默认取值: 不涉及 |
error_info |
否 |
ErrorResponse object |
错误信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
duration |
否 |
Integer |
参数解释: 时长,单位秒。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及 取值范围: 0-86400 |
audio_codec |
否 |
String |
参数解释: 音频编码格式。 约束限制: 用户无需填写,系统自行提取。 取值范围: 字符长度0-32位。 默认取值: 不涉及 |
audio_bit_rate |
否 |
Integer |
参数解释: 音频平均码率,单位kbps。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及 取值范围: 0-16384 |
audio_channels |
否 |
Integer |
参数解释: 音频声道数。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及 取值范围: 0-100 |
sample |
否 |
Integer |
参数解释: 采样率,HZ。 约束限制: 用户无需填写,系统自行提取。 默认取值: 不涉及 取值范围: 0-100000 |
error_info |
否 |
ErrorResponse object |
错误信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action |
否 |
String |
参数解释: 操作。 约束限制: 系统属性仅为系统设置,普通用户无法修改。 取值范围:
默认取值: 不涉及 |
key |
否 |
String |
参数解释: 系统属性条目。 约束限制: 系统属性仅为系统设置,普通用户无法修改。 取值范围: 公共资产属性:
分身数字人资产属性:
视频翻译资产属性:
3D数字人资产属性:
默认取值: 不涉及 |
value |
否 |
String |
参数解释: 系统属性属性值。 约束限制: 系统属性仅为系统设置,普通用户无法修改。 取值范围: 字符长度1-1024位 默认取值 不涉及 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
asset_id |
String |
数字资产ID。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
POST https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/digital-assets { "asset_name" : "云笙模型", "asset_description" : "数字人员工", "asset_type" : "HUMAN_MODEL", "tags" : [ "数字人员工" ] }
响应示例
状态码: 200
成功。
{ "asset_id" : "93769b5a-c8c6-4692-9c95-53933a1f0c93" }
状态码: 400
{ "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" }
状态码
状态码 |
描述 |
---|---|
200 |
成功。 |
400 |
请求传参异常,包含错误码及对应描述。 |
错误码
请参见错误码。