Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
Software Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Creating an Asset

Function

Adds and uploads new media assets, including the virtual avatar model, background image, material image and video, and PowerPoint, to the asset library.

  • NOTE:

    If the asset type is IMAGE, system_properties is used to classify the background image (BACKGROUND_IMG) and the material image (MATERIAL_IMG).

  • NOTE:

    If the asset type is VIDEO, system_properties is used to classify material videos (MATERIAL_VIDEO) and business card videos (BUSSINESS_CARD_VIDEO).

  • NOTE:

    system_properties with CREATED_BY_PLATFORM is used to classify VIDEO assets generated by MetaStudio.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/digital-assets

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

You can obtain the token by calling the IAM API used to obtain a user token.

Value of X-Subject-Token in the response header.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

The format is YYYYMMDD'T'HHMMSS'Z'.

X-App-UserId

No

String

Third-party user ID, which does not allow Chinese characters.

X-MSS-Authorization

No

String

Internal token of virtual humans.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

asset_name

Yes

String

Details:

Asset name.

Constraints:

N/A

Options:

The value contains 0 to 256 characters.

Default value:

N/A

asset_description

No

String

Details:

Asset description.

Constraints:

N/A

Options:

The value contains 0 to 4,096 characters.

Default value:

N/A

asset_type

Yes

String

Details:

Asset type.

Constraints:

VOICE_MODEL and HUMAN_MODEL_2D are not available for common users.

Options:

Public asset type. Options:

  • VOICE_MODEL: timbre model

  • VIDEO: video file

  • IMAGE: image file

  • PPT: slide file

  • MUSIC: music

  • AUDIO: audio

  • COMMON_FILE: common file

Virtual avatar asset. Options:

  • HUMAN_MODEL_2D: virtual avatar model

  • BUSINESS_CARD_TEMPLATE: business card template

3D virtual human asset. Options:

  • HUMAN_MODEL: 3D virtual human model

  • SCENE: scene model

  • ANIMATION: animated action

  • MATERIAL: stylized material

  • NORMAL_MODEL: general model

Default value:

N/A

review_config

No

ReviewConfig object

Configures content review.

tags

No

Array of strings

Details:

Tags.

NOTE:

Avatar system asset tag definition:

  • Field: NEWS, BUSINESS, E_COMMERCE, MARKETING, KNOWLEDGE, EDUCATION, MEDICAL, SPORTS

  • Gender: MALE, FEMALE

  • Posture: FULL_BODY, HALF_BODY, STANDING, SITTING, FRONT_PHOTO, SIDE_PHOTO

  • Region: ASIAN, WESTERN, MIDDLE_EASTERNER, AFRICAN, LATINO

Constraints:

N/A

Options:

A maximum of 50 tags are allowed.

A tag contains 0 to 128 characters.

Default value:

N/A

asset_extra_meta

No

AssetExtraMeta object

Details:

Additional asset metadata.

Constraints:

Select a structure based on asset_type. Other unmatched structures will be ignored.

  • HUMAN_MODEL: Enter human_model_meta.

  • HUMAN_MODEL_2D: Enter human_model_2d_meta.

  • SCENE: Enter scene_meta.

  • ANIMATION: Enter animation_meta.

  • MATERIAL: Enter material_meta.

  • VOICE_MODEL: Enter voice_model_meta.

  • VIDEO: Enter video_meta.

  • IMAGE: Enter image_meta.

  • PPT: Enter ppt_meta.

  • AUDIO: Enter audio_meta.

system_properties

No

Array of SystemProperty objects

Details:

Sets system properties. This is an internal parameter and common users do not need to set it.

Constraints:

N/A

Options:

The maximum number is 50.

Default value:

N/A

shared_config

No

AssetSharedConfig object

Details:

Configures asset sharing.

Constraints:

Currently, this parameter is used only for asset sharing related to livestreaming template sharing.

Options:

N/A

Default value:

N/A

is_need_generate_cover

No

Boolean

Details:

Whether to generate a thumbnail.

Constraints:

This parameter is used only for video assets.

Options:

  • true: A thumbnail is automatically generated.

  • false: A thumbnail is not automatically generated.

Default value:

false

asset_order

No

Integer

Details:

Specifies the display sequence on the console.

If the values are the same, the latest value is placed in the front by default.

Constraints:

N/A

Default value:

N/A

Value range:

0-32767

supported_service

No

Array of strings

Supported service type. Options:

  • VIDEO_2D: virtual avatar video production

  • LIVE_2D: virtual avatar livestreaming

  • CHAT_2D: virtual avatar intelligent interaction

Table 4 ReviewConfig

Parameter

Mandatory

Type

Description

no_need_review

No

Boolean

Content review whitelist. This feature is available only for users in the whitelist. The auto review policies apply to other users.

Table 5 AssetExtraMeta

Parameter

Mandatory

Type

Description

human_model_meta

No

HumanModelAssetMeta object

Virtual human model metadata.

voice_model_meta

No

VoiceModelAssetMeta object

Timbre model metadata.

ppt_meta

No

PPTAssetMeta object

PPT asset metadata information.

animation_meta

No

AnimationAssetMeta object

Animated action asset metadata.

scene_meta

No

SceneAssetMeta object

Scenario metadata.

material_meta

No

MaterialAssetMeta object

Material metadata.

human_model_2d_meta

No

HumanModel2DAssetMeta object

Virtual avatar model metadata

image_meta

No

ImageAssetMeta object

Image metadata

video_meta

No

VideoAssetMeta object

Video metadata, which is automatically extracted.

audio_meta

No

AudioAssetMeta object

Audio metadata, which is automatically extracted.

Table 6 HumanModelAssetMeta

Parameter

Mandatory

Type

Description

style_id

No

String

Details:

Virtual human model style ID.

Constraints:

Currently, only the preset styles are supported.

Options:

  • system_male_001: male style 01

  • system_female_001: female style 01

  • system_male_002: male style 02

  • system_female_002: female style 02

Default value:

N/A

modeling_type

No

String

Details:

Virtual human modeling type.

Constraints:

N/A

Options:

  • UPLOADED: model uploaded by a tenant

  • PICTURE_MODELING: model generated from a photo

  • CHARACTER_CUSTOMIZATION_MODELING: model generated through face avatar creation

Default value:

UPLOADED

modeling_job_id

No

String

Details:

Modeling task ID.

Constraints:

This parameter is automatically specified only when it is a model generated by MetaStudio.

Options:

The value contains 0 to 64 characters.

Default value:

N/A

model_properties

No

HumanModelMetaProperties object

Records model configuration information.

components

No

Array of ComponentInfo objects

Replaceable components.

Table 7 HumanModelMetaProperties

Parameter

Mandatory

Type

Description

whole_model_base_file_id

No

String

Details:

Model file_id used to generate WHOLE_MODEL

Constraints:

If the recorded information is the same as the value of file_id in the main file, the model has been generated and there is no need to export the entire model.

Options:

The value contains 0 to 64 characters.

Default value:

N/A

load_model_file_id

No

String

Details:

Model file_id used for rendering.

Constraints:

If the value is empty or no match is found, the main file is used.

Options:

The value contains 0 to 64 characters.

Default value:

N/A

Table 8 ComponentInfo

Parameter

Mandatory

Type

Description

component_name

Yes

String

Details:

Component name.

Constraints:

N/A

Options:

The value contains 1 to 256 characters.

Default value:

N/A

component_type

Yes

String

Details:

Component type.

Constraints:

N/A

Options:

The value contains 1 to 256 characters.

Default value:

N/A

component_desc

No

String

Details:

Component description.

Constraints:

N/A

Options:

The value contains 0 to 512 characters.

Default value:

N/A

Table 9 VoiceModelAssetMeta

Parameter

Mandatory

Type

Description

order

No

Integer

Details:

Display order.

Constraints:

N/A

Value range:

0-32767

Default value:

999

model_type

No

String

Details:

Voice asset type.

Constraints:

N/A

Options:

  • COMMON: general emotion model

  • CLONE: voice cloning model

Default value:

CLONE

sex

No

String

Details:

Voice gender.

Constraints:

N/A

Options:

  • UNKNOW: voice of an unknown gender

  • MALE: male voice

  • FEMALE: female voice

Default value:

UNKNOW

language

No

String

Details:

Voice language.

Constraints:

N/A

Options:

  • UNKNOW: unknown

  • CN: Chinese

  • EN: English

  • GER: German

  • fr: French

  • Kr: Korean

  • por: Portuguese

  • JPN: Japanese

  • Ita: Italian

  • ESP: Spanish

  • DBH: Northeast China dialect

  • GT: Hong Kong & Taiwan dialect

  • GXH: Guangxi dialect

  • HBH: Hubei dialect

  • SXH: Shaanxi dialect

  • SCH: Sichuan dialect

  • YY: Cantonese

  • Russian: Russian

  • Filipino: Tagalog

  • Dutch: Dutch

  • Indonesian: Indonesian

  • Vietnamese: Vietnamese

  • Arabic: Arabic

  • Turkish: Turkish

  • Malay: Malay

  • Thai: Thai

  • Finnish: Finnish

Default value:

UNKNOW

speed_ratio

No

Float

Details:

Speaking speed zoom ratio.

Constraints:

N/A

Value range:

0-100

Default value:

1

volume_ratio

No

Float

Details:

Volume zoom ratio.

Constraints:

N/A

Value range:

0-100

Default value:

1

is_realtime_voice

No

Boolean

Details:

Whether the timbre supports real-time synthesis.

Constraints:

Timbre that supports real-time synthesis can be used for livestreaming and intelligent interaction. Timbre that does not support real-time synthesis can only be used for video production.

Options:

  • true: Real-time synthesis is supported.

  • false: Real-time synthesis is not supported.

Default value:

true

style

No

String

Style reference

external_voice_meta

No

ExternalVoiceAssetMeta object

Third-party TTS timbre metadata.

is_support_vc_process

No

Boolean

Whether VC is supported.

Default value:

false

is_flexus

No

Boolean

Whether the voice is of the Flexus edition.

Default value:

false

Table 10 ExternalVoiceAssetMeta

Parameter

Mandatory

Type

Description

provider

Yes

String

Third-party TTS vendor. Options:

  • XIMALAYA: Himalaya TTS

  • HUAWEI_EI: Huawei Cloud EI TTS

  • MOBVOI: DupDub TTS

  • AUDIOX: AudioX TTS

  • SINOVOICE: SinoVoice TTS

  • DATABAKER: Databaker TTS

  • AISPEECH: AISpeech TTS

Table 11 PPTAssetMeta

Parameter

Mandatory

Type

Description

auto_analysis

No

Boolean

Details:

Whether the PowerPoint file needs to be automatically parsed.

Constraints:

Parsing some complex PowerPoint files or PowerPoint files with a high compression ratio may fail.

If the PowerPoint file contains more than 50 pages, only the first 50 pages will be converted.

The converted images may not be completely restored. You need to confirm the restoration result.

Options:

  • true: automatic parsing

  • false: automatic parsing not required

Default value:

false

ppt_analysis_status

No

String

Details:

PowerPoint file parsing status.

Constraints:

N/A

Options:

  • INITIALIZE: initial

  • WAITING: waiting for parsing

  • CONVERTING: parsing...

  • FAILED: failed

  • SUCCEEDED: succeeded

  • CANCELED: canceled

Default value:

N/A

error_info

No

ErrorResponse object

Error information

page_count

No

Integer

Details:

Total number of PowerPoint pages.

Constraints:

N/A

Value range:

0-256

Default value:

0

pages

No

Array of PPTPageInfo objects

PPT page image.

Table 12 PPTPageInfo

Parameter

Mandatory

Type

Description

page_no

No

Integer

Details:

Page number.

Constraints:

N/A

Value range:

1-256

file_id

No

String

Details:

ID of the image file of a specified page.

Constraints:

N/A

Options:

The value contains 1 to 64 characters.

Default value:

N/A

page_content

No

String

Details:

ID of the image file of a specified page

Constraints:

N/A

Options:

The value contains 0 to 2,048 characters.

Default value:

N/A

Table 13 AnimationAssetMeta

Parameter

Mandatory

Type

Description

style_id

No

String

Virtual human model style ID.

duration

No

Float

Animation duration.

Value range:

0-32767

Default value:

0

auto_analysis

No

Boolean

Indicates whether an action needs to be automatically parsed.

Default value:

false

voice_delay

No

Float

Delay duration for playing a voice.

Unit: second

For example, if the entry animation lasts for 3 seconds and voice_delay is set to 4 seconds, the voice is played from the fourth second on after the entry animation starts.

Value range:

0-100

Default value:

0

animation_insert_restriction

No

String

Limit on the position where an animation is inserted.

  • ONLY_BEGINNING: During video production, the animation can appear only in the beginning.

  • ONLY_END: During video production, the animation can appear only in the end.

Table 14 SceneAssetMeta

Parameter

Mandatory

Type

Description

components

No

Array of SceneComponentInfo objects

Operable components (such as the screen, light, and camera).

default_configs

No

Map<String,SceneComponentInfo>

Default scene settings (camera position and initial person position).

Table 15 SceneComponentInfo

Parameter

Mandatory

Type

Description

index

No

Integer

Component index.

Value range:

1-10

component_name

Yes

String

Component name.

component_type

Yes

String

Component type.

  • CAMERA: camera

  • PANEL: screen

  • LIGHT: light

component_desc

No

String

Component description.

Table 16 MaterialAssetMeta

Parameter

Mandatory

Type

Description

components

No

Array of MaterialComponentInfo objects

Replaceable material components.

Table 17 MaterialComponentInfo

Parameter

Mandatory

Type

Description

component_name

Yes

String

Material component name.

component_type

Yes

String

Material component type.

  • CLOTHES: clothes

  • PANTS: pants

  • SHOES: shoes

  • HAIR: hair

  • EYELASH: eyelashes

  • EYEBROW: eyebrows

component_desc

No

String

Material component description.

Table 18 HumanModel2DAssetMeta

Parameter

Mandatory

Type

Description

is_action_editable

No

Boolean

Details:

Whether the actions of a virtual avatar can be edited.

Constraints:

N/A

Options:

  • true: editable

  • false: not editable

Default value:

false

is_real_background

No

Boolean

Details:

Whether it is a real-scene virtual avatar.

Constraints:

If yes, the background does not need to be changed.

Options:

  • true: real-scene virtual avatar

  • false: general virtual avatar without background

Default value:

false

support_live

No

Boolean

Details:

Whether livestreaming is supported.

Constraints:

N/A

Options:

  • true: supported

  • false: unsupported

Default value:

false

model_version

No

String

Details:

Virtual avatar model version

Constraints:

N/A

Options:

  • V2: V2 model

  • V3: V3 model

  • V3_2: V3.2 model

Default value:

V2

model_resolution

No

String

Details:

Virtual avatar model resolution.

Constraints:

N/A

Options:

  • 1080P: 1080p. 1080p or 720p video can be output.

  • 4K: 4K. 4K, 1080p, or 720p video can be output.

Default value:

1080P

device_names

No

Array of strings

Details:

Devices for which compilation tasks have been executed.

Constraints:

Walking virtual avatars can be used only for video production.

Options:

A maximum of 16 device names are allowed.

A device name contains 1 to 64 characters.

Default value:

false

is_with_action_library

No

Boolean

Whether the virtual avatar has an atomic action library.

NOTE:
  • A virtual avatar with an atomic action library supports choreography.

Default value:

false

action_tag_map

No

Array of ActionTagInfo objects

Action tag mapping.

is_flexus

No

Boolean

Whether it is a Flexus virtual avatar.

Default value:

false

Table 19 ActionTagInfo

Parameter

Mandatory

Type

Description

action_name_zh

Yes

String

Atomic action name in Chinese.

action_name_en

Yes

String

Atomic action name in English.

catalog

No

String

Action category name.

file_name

No

String

Sample video file name. The value contains 1 to 256 characters.

tag

No

String

Action tag.

Table 20 ImageAssetMeta

Parameter

Mandatory

Type

Description

codec

No

String

Details:

Image encoding format.

Constraints:

Automatically extracted.

Options:

The value contains 0 to 32 characters.

Default value:

N/A

width

No

Integer

Details:

Image width.

Constraints:

Automatically extracted.

Default value:

N/A

Value range:

0-8196

height

No

Integer

Details:

Image height.

Constraints:

Automatically extracted.

Default value:

N/A

Value range:

0-8196

size

No

Number

Details:

Image size.

Constraints:

Automatically extracted.

Default value:

N/A

Value range:

0-9223372036854775807

mode

No

String

Details:

Image form.

Constraints:

Automatically extracted.

Options:

  • Horizontal: horizontal

  • Vertical: vertical

Default value:

N/A

error_info

No

ErrorResponse object

Error message

Table 21 VideoAssetMeta

Parameter

Mandatory

Type

Description

video_codec

No

String

Details:

Video encoding format.

Constraints:

Automatically extracted.

Options:

The value contains 0 to 32 characters.

Default value:

N/A

width

No

Integer

Details:

Video image width.

Constraints:

Automatically extracted.

Default value:

N/A

Value range:

0-8196

height

No

Integer

Details:

Video height.

Constraints:

Automatically extracted.

Default value:

N/A

Value range:

0-8196

frame_rate

No

String

Details:

Video frame rate.

Constraints:

Automatically extracted.

Options:

The value contains 0 to 32 characters.

Default value:

N/A

video_bit_rate

No

Integer

Details:

Average video bitrate, in kbit/s.

Constraints:

Automatically extracted.

Default value:

N/A

Value range:

0-104857600

duration

No

Integer

Details:

Duration, in second.

Constraints:

Automatically extracted.

Default value:

N/A

Value range:

0-86400

audio_codec

No

String

Details:

Audio encoding format.

Constraints:

Automatically extracted.

Options:

The value contains 0 to 32 characters.

Default value:

N/A

audio_bit_rate

No

Integer

Details:

Average audio bitrate, in kbit/s.

Constraints:

Automatically extracted.

Default value:

N/A

Value range:

0-16384

audio_channels

No

Integer

Details:

Number of audio channels.

Constraints:

Automatically extracted.

Default value:

N/A

Value range:

0-100

sample

No

Integer

Details:

Sampling rate, in Hz.

Constraints:

Automatically extracted.

Default value:

N/A

Value range:

0-100000

mode

No

String

Details:

Horizontal or vertical display.

Constraints:

Automatically extracted.

Options:

  • Horizontal: horizontal

  • Vertical: vertical

Default value:

N/A

video_transcoding_status

No

String

Details:

Video transcoding status.

Constraints:

Automatically filled.

Options:

  • WAITING: waiting for transcoding

  • TRANSCODING: transcoding...

  • FAILED: failed

  • SUCCEEDED: succeeded

Default value:

N/A

error_info

No

ErrorResponse object

Error message

Table 22 AudioAssetMeta

Parameter

Mandatory

Type

Description

duration

No

Integer

Details:

Duration, in second.

Constraints:

Automatically extracted.

Default value:

N/A

Value range:

0-86400

audio_codec

No

String

Details:

Audio encoding format.

Constraints:

Automatically extracted.

Options:

The value contains 0 to 32 characters.

Default value:

N/A

audio_bit_rate

No

Integer

Details:

Average audio bitrate, in kbit/s.

Constraints:

Automatically extracted.

Default value:

N/A

Value range:

0-16384

audio_channels

No

Integer

Details:

Number of audio channels.

Constraints:

Automatically extracted.

Default value:

N/A

Value range:

0-100

sample

No

Integer

Details:

Sampling rate, in Hz.

Constraints:

Automatically extracted.

Default value:

N/A

Value range:

0-100000

error_info

No

ErrorResponse object

Error message

Table 23 ErrorResponse

Parameter

Mandatory

Type

Description

error_code

No

String

Error code.

error_msg

No

String

Error description.

Table 24 SystemProperty

Parameter

Mandatory

Type

Description

action

No

String

Details:

Operation.

Constraints:

System properties cannot be modified by common users.

Options:

  • ADD: adding

  • DELETE: deleting

Default value:

N/A

key

No

String

Details:

System property.

Constraints:

System properties cannot be modified by common users.

Options:

Public asset property. Options:

  • BACKGROUND_IMG: 2D background image for video production. Set value to Yes.

  • CREATED_BY_PLATFORM: whether it is generated by the platform

Virtual avatar asset property. Options:

  • MATERIAL_IMG: material image, which is used as an image layer. Set value to Yes.

  • MATERIAL_VIDEO: material video, which is used as a video layer. Set value to Yes.

  • DIGITAL_HUMAN_2D_VIDEO: virtual avatar video

  • DIGITAL_HUMAN_3D_VIDEO: 3D virtual human video

  • BUSINESS_CARD_VIDEO: business card video

  • BUSSINESS_CARD_VIDEO: business card video (expired)

  • PHOTO_VIDEO: photo-based virtual avatar video

Video translation asset property. Options:

  • TO_BE_TRANSLATED_VIDEO: source video for translation The value can be Yes.

  • TRANSLATED_VIDEO: translated video

3D virtual human asset attribute. Options:

  • STYLE_ID: style ID

  • DH_ID: virtual human ID (not available yet)

  • PLATFORM_AVAILABLE: whether the platform is available (not available yet)

  • RENDER_ENGINE: engine type. Set value to UE or MetaEngine.

  • BACKGROUND_SCENE: 2D background scene for video production. Set value to Horizontal or Vertical.

  • LAYER_CONFIG_ENABLE: available foreground layer configuration

Default value:

N/A

value

No

String

Details:

System attribute value.

Constraints:

System properties cannot be modified by common users.

Options:

The value contains 1 to 1,024 characters.

Default value:

N/A

Table 25 AssetSharedConfig

Parameter

Mandatory

Type

Description

shared_type

No

String

Sharing type.

  • PRIVATE: accessible only to the current tenant

  • PUBLIC: accessible to all tenants. Currently, only system assets are accessible to all tenants.

  • SHARED: accessible to specified tenants, who are specified by the owner.

expire_time

No

String

Time when the sharing expires. The default value is 30 days, that is, 23:59:59 on the day when sharing starts plus 30 days.

allowed_project_ids

No

Array of strings

Tenants allowed to access the asset.

Response Parameters

Status code: 200

Table 26 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.

Table 27 Response body parameters

Parameter

Type

Description

asset_id

String

Digital asset ID.

Status code: 400

Table 28 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

POST https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/digital-assets

{
  "asset_name" : "Sara Model",
  "asset_description" : "Virtual employee",
  "asset_type" : "HUMAN_MODEL",
  "tags" : [ "Virtual employee" ]
}

Example Responses

Status code: 200

Successful.

{
  "asset_id" : "93769b5a-c8c6-4692-9c95-53933a1f0c93"
}

Status code: 400

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

Status Codes

Status Code

Description

200

Successful.

400

Parameters error, including the error code and its description.

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback