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

Querying Virtual Avatar Video Production Task Details

Function

Queries virtual avatar video production task details.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/2d-digital-human-videos/{job_id}

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.

job_id

Yes

String

Task ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

show_script

No

Boolean

Whether to return the script parameter configuration.

Default value:

false

Request Parameters

Table 3 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-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

X-App-UserId

No

String

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

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

state

String

Task status. Options:

  • WAITING: The task is waiting for execution.
  • PROCESSING: The task is being processed.
  • SUCCEED: Task execution succeeded.
  • FAILED: Task execution failed.
  • CANCELED: The task has been canceled.
  • BLOCK: The task has been frozen.

job_type

String

Task type.

  • 2D_DIGITAL_HUMAN_VIDEO: virtual avatar video production task
  • PHOTO_DIGITAL_HUMAN_VIDEO: photo-based virtual human video production

start_time

String

Start time of virtual human video production.

end_time

String

End time of virtual human video production.

duration

Float

Details:

Virtual avatar video duration.

Value range:

0-2147483647

output_asset_config

OutputAssetInfo object

Output asset information.

error_info

ErrorResponse object

Error message.

create_time

String

Task creation time.

lastupdate_time

String

Task update time.

script_id

String

Script ID.

video_making_type

String

Video generation mode. If this parameter is set to MODEL, model_asset_id is mandatory. If this parameter is set to PICTURE, human_image is mandatory.

  • MODEL: Generates a video from a virtual avatar model.
  • PICTURE: Generates a video from one photo.
NOTE:
  • This parameter has been discarded. The API for creating a photo-based virtual avatar video production task will be used.

human_image

String

Person photo, which must be encoded using Base64.

NOTE:
  • This parameter has been discarded. The API for creating a photo-based virtual avatar video production task will be used.

model_asset_id

String

Virtual avatar model asset ID, which can be queried from the asset library.

voice_config

VoiceConfig object

Voice configuration parameter.

video_config

VideoConfig object

Video output configuration.

shoot_scripts

Array of ShootScriptItem objects

Shooting script list.

background_music_config

BackgroundMusicConfig object

Background music configuration.

Table 6 OutputAssetInfo

Parameter

Type

Description

asset_id

String

Output video asset ID.

asset_name

String

Output video asset name.

cover_url

String

Video thumbnail URL.

preview_video_url

String

URL for downloading a preview video. The validity period of the URL is 24 hours.

NOTE:
  • Virtual avatar videos do not support preview.
Table 7 ErrorResponse

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Table 8 VoiceConfig

Parameter

Type

Description

voice_asset_id

String

Details:

Timbre asset ID, which can be queried from the asset library.

Constraints:

N/A

Options:

The value contains 1 to 256 characters.

Default value:

N/A

speed

Integer

Details:

Speaking speed. 50 indicates 0.5x speaking speed, 100 indicates normal speaking speed, and 200 indicates 2x speaking speed.

The value 100 indicates the normal speaking speed of an adult, which is about 150 words per minute.

Constraints:

N/A

Value range:

50-200

Default value:

100

pitch

Integer

Details:

Pitch.

Constraints:

N/A

Value range:

50-200

Default value:

100

volume

Integer

Details:

Volume.

Constraints:

N/A

Value range:

90-240

Default value:

140

Table 9 VideoConfig

Parameter

Type

Description

clip_mode

String

Details:

Clipping mode of the output video.

Constraints:

N/A

Options:

  • RESIZE: video scaling
  • CROP: video cropping

Default value:

RESIZE

codec

String

Details:

Video encoding format and video file format.

Constraints:

Only virtual avatar video production supports VP8 encoding.

Options:

  • H264: H.264 encoding, MP4 file output
  • VP8: VP8 encoding, WebM file output

Default value:

N/A

bitrate

Integer

Details:

Average output bitrate. Unit: kbit/s

Constraints:

  • Quality is prioritized for virtual avatar video production, which may exceed the preset bitrate.
  • Bitrate range for virtual avatar video production: [1000, 8000].

Default value:

N/A

Value range:

40-30000

width

Integer

Details:

Video width. Unit: pixel.

Constraints:

  • When clip_mode is set to RESIZE, the following resolutions are supported: 1920 x 1080, 1080 x 1920, 1280 x 720, 720 x 1280, 3840 x 2160, and 2160 x 3840. 4K is available only when the virtual avatar model supports 4K.
  • When clip_mode is set to CROP, (dx, dy) is the origin, and the width is the actual width of the reserved video.
  • Currently, only 1080 x 1920 and 1920 x 1080 are supported for virtual avatar livestreaming.

Default value:

N/A

Value range:

0-3840

height

Integer

Details:

Video height.

Unit: pixel.

Constraints:

  • When clip_mode is set to RESIZE, the following resolutions are supported: 1920 x 1080, 1080 x 1920, 1280 x 720, 720 x 1280, 3840 x 2160, and 2160 x 3840.
  • When clip_mode is set to CROP, (dx, dy) is the origin, and the height is the actual height of the reserved video.
  • Currently, only 1080 x 1920 and 1920 x 1080 are supported for virtual avatar livestreaming.

Default value:

N/A

Value range:

0-3840

frame_rate

String

Details:

Frame rate. Unit: FPS

Constraints:

The virtual avatar video frame rate is fixed at 25 FPS.

Default value:

25

is_subtitle_enable

Boolean

Details:

Whether the output video is subtitled.

Constraints:

Subtitles are not supported for virtual avatar livestreaming.

Options:

  • true: enable subtitling
  • false: disable subtitling

Default value:

false

subtitle_config

SubtitleConfig object

Subtitle configuration.

disable_system_watermark

Boolean

Details:

Indicates whether the system watermark is disabled for the output video.

Constraints:

Currently, this parameter takes effect only for trustlisted tenants.

Value range:

  • true
  • false

Default value:

false

dx

Integer

Details:

Horizontal coordinate of the pixel in the upper left corner of the cropped video.

NOTE:

The image layout size is based on the model resolution. For example, for a model with the resolution of 1920 x 1080, the value of dx ranges from 0 to 1920.

Constraints:

This parameter takes effect when clip_mode is set to CROP.

Default value:

N/A

Value range:

-1920-3840

dy

Integer

Details:

Vertical coordinate of the pixel in the upper left corner of the cropped video.

NOTE:

The image layout size is based on the model resolution. For example, for a model with the resolution of 1920 x 1080, the value of dy ranges from 0 to 1080.

Constraints:

This parameter takes effect when clip_mode is set to CROP.

Default value:

N/A

Value range:

-1920-3840

is_enable_super_resolution

Boolean

Details:

Whether super resolution is enabled for a video.

Constraints:

This parameter is available only for virtual avatar video production.

Options:

  • true: enable
  • false: do not enable

Default value:

false

Table 10 SubtitleConfig

Parameter

Type

Description

dx

Integer

Details:

Coordinates of the pixel in the lower left corner of the subtitle box.

Constraints:

N/A

Default value:

N/A

Value range:

0-1920

dy

Integer

Details:

Coordinates of the pixel in the lower left corner of the subtitle box.

Constraints:

N/A

Default value:

N/A

Value range:

0-1920

font_name

String

Details:

Font. The following fonts are supported:

  • HarmonyOS_Sans_SC_Black: HarmonyOS bold
  • HarmonyOS_Sans_SC_Regular: HarmonyOS normal
  • HarmonyOS_Sans_SC_Thin: HarmonyOS light

Constraints:

N/A

Options:

The value contains 0 to 64 characters.

Default value:

HarmonyOS_Sans_SC_Black

font_size

Integer

Details:

Font size. The interface value ranges from 0 to 120. The actual value range is 4 to 120. Use the actual value range.

Constraints:

N/A

Value range:

0-120

Default value:

54

h

Integer

Details:

Subtitle box height.

Constraints:

The parameter h is used to facilitate the calculation of the coordinates in the upper left corner of the subtitle box. This parameter is not used in the background.

Value range:

0-1920

w

Integer

Details:

Subtitle box width.

Constraints:

  • The subtitle box width is fixed at 80/ %of the screen width.
  • The parameter w is used to facilitate the calculation of the coordinates in the upper left corner of the subtitle box. This parameter is not used in the background.

Value range:

0-1920

Table 11 ShootScriptItem

Parameter

Type

Description

sequence_no

Integer

Details:

Script No.

Constraints:

The sequence number of a script must be unique.

Default value:

N/A

Value range:

0-2147483647

start_time

Float

Details:

Start time.

The unit is second.

Start time relative to the content.

Constraints:

Reserved field. Currently, only sequence_no needs to be set.

Default value:

N/A

Value range:

0-2592000

end_time

Float

Details:

End time.

The unit is second.

End time relative to the content.

Constraints:

Reserved field. Currently, only sequence_no needs to be set.

Default value:

N/A

Value range:

0-2592000

shoot_script

ShootScript object

Performance script.

subtitle_file_info

SubtitleFiles object

Subtitle file information.

Table 12 ShootScript

Parameter

Type

Description

script_type

String

Details:

Script type, that is, the control mode of video production.

Constraints:

N/A

Options:

TEXT: text control, that is, using TTS

AUDIO: speech control

Default value:

TEXT

text_config

TextConfig object

Commentary configuration.

audio_drive_action_config

Array of AudioDriveActionConfig objects

Action configuration for speech control.

animation_config

Array of AnimationConfig objects

Action configuration.

NOTE:
  • You are advised to insert action tags in text_config and do not configure animation_config.
  • Use animation_config to configure actions. The actions are played cyclically throughout the explanation.
  • This parameter does not take effect for virtual avatar video production.

background_config

Array of BackgroundConfigInfo objects

Background configuration.

emotion_config

Array of EmotionConfig objects

Emotion tag configuration.

NOTE:
  • This parameter does not take effect for virtual avatar video production.
  • You are advised to insert emotion tags in text_config. This parameter will be discarded.

layer_config

Array of LayerConfig objects

Layer configuration.

Table 13 TextConfig

Parameter

Type

Description

text

String

Details:

Script. Two modes are supported: plain text mode and tag mode.

  • Plain text mode, for example, "Hello, everyone, I'm a virtual streamer."
  • Tag mode: For details about the definition of SSML tags, see SSML Definition of Text Control.

Constraints:

The value can contain a maximum of 10,000 characters, excluding the SSML tag.

Options:

The value contains 0 to 131,072 characters.

Default value:

N/A

Table 14 AudioDriveActionConfig

Parameter

Type

Description

action_tag

String

Action tag

action_name

String

Action name

action_start_time

Float

Action start time

Value range:

0-2592000

Table 15 AnimationConfig

Parameter

Type

Description

animation

String

Action asset ID.

Table 16 BackgroundConfigInfo

Parameter

Type

Description

background_type

String

Details:

Background type.

Constraints:

N/A

Options:

  • IMAGE: image background, which is used as the virtual avatar video background
  • COLOR: solid color background. The RGB value of the specified color is used as the virtual avatar video background.

Default value:

N/A

background_title

String

Background title.

NOTE:
  • This parameter does not take effect for virtual avatar video production.

human_position_2d

HumanPosition2D object

Position of a virtual avatar in the background image. If this parameter is not set, the virtual avatar is in the middle of the image by default.

NOTE:
  • This parameter is discarded. The position of a virtual avatar in the background image is configured in the layer_config parameter.

human_size_2d

HumanSize2D object

Size of a virtual avatar in the background image.

NOTE:
  • This parameter is discarded. The size of a virtual avatar in the background image is configured in the layer_config parameter.

background_cover_url

String

URL for downloading the thumbnail image of a video file.

This parameter is valid only when the presentation material is a video.

NOTE:
  • This parameter does not take effect for virtual avatar video production.

background_config

String

Details:

Background file URL.

Constraints:

  • External URLs are allowed only for livestreaming. For other services, obtain a URL from the asset library.
  • This parameter is mandatory when background_type is set to IMAGE.

Options:

The value contains 1 to 2,048 characters.

Default value:

N/A

background_color_config

String

Details:

RGB color value of a solid color background.

Constraints:

This parameter is mandatory when background_type is set to COLOR.

Options:

The value contains 0 to 16 characters.

Default value:

#FFFFFF

background_asset_id

String

Details:

Background asset ID.

NOTE:

If a background image is used, enter the image asset ID.

Constraints:

N/A

Options:

The value contains 0 to 64 characters.

Default value:

N/A

Table 17 HumanPosition2D

Parameter

Type

Description

position

String

Position of a virtual avatar in the background image.

  • LEFT: left
  • MIDDLE: middle
  • RIGHT: right
NOTE:

If the values of position_x and position_y exist, position does not take effect.

Default value:

MIDDLE

position_x

Integer

X-axis position of the virtual avatar, that is, the X-axis pixel value of the center point at the bottom of the virtual avatar image.

The resolution of the landscape (16:9) background image is 1920 x 1080 pixels. The resolution of the portrait (9:16) background image is 1080 x 1920 pixels.

Value range:

-1920-3840

position_y

Integer

Y-axis position of the virtual avatar, that is, the Y-axis pixel value of the center point at the bottom of the virtual avatar image.

The resolution of the landscape (16:9) background image is 1920 x 1080 pixels. The resolution of the portrait (9:16) background image is 1080 x 1920 pixels.

Value range:

-1920-3840

Table 18 HumanSize2D

Parameter

Type

Description

width

Integer

Width (in pixel) of a virtual avatar.

The resolution of the landscape (16:9) background image is 1920 x 1080 pixels. The resolution of the portrait (9:16) background image is 1080 x 1920 pixels.

Value range:

1-7680

height

Integer

Height (in pixel) of a virtual avatar.

The resolution of the landscape (16:9) background image is 1920 x 1080 pixels. The resolution of the portrait (9:16) background image is 1080 x 1920 pixels.

Value range:

1-7680

Table 19 EmotionConfig

Parameter

Type

Description

emotion

String

Emotion tag configuration.

  • HAPPY: happy
  • SAD: sad
  • CALM: calm
  • ANGER: angry

The default value is HAPPY.

Default value:

HAPPY

Table 20 LayerConfig

Parameter

Type

Description

layer_type

String

Details:

Layer type.

Constraints:

N/A

Options:

  • HUMAN: person layer
  • IMAGE: image layer
  • VIDEO: video layer
  • TEXT: text layer

Default value:

N/A

asset_id

String

Details:

ID of the asset overlaid on a video. You do not need to set this parameter for external assets.

Constraints:

N/A

Options:

The value contains 0 to 64 characters.

Default value:

N/A

group_id

String

Details:

Groups materials in multiple scenes. Materials with the same group_id share location information when they are applied globally.

Constraints:

N/A

Options:

The value contains 0 to 64 characters.

Default value:

N/A

position

LayerPositionConfig object

Layer position configuration.

size

LayerSizeConfig object

Layer size configuration.

image_config

ImageLayerConfig object

Material image layer configuration.

video_config

VideoLayerConfig object

Material video layer configuration.

text_config

TextLayerConfig object

Material text layer configuration.

Table 21 LayerPositionConfig

Parameter

Type

Description

dx

Integer

Details:

X axis position of the pixel in the upper left corner of the image. The coordinate of the upper left corner of the image layout is 0x0.

The image layout resolution is 1920 x 1080 in landscape mode (16:9) and 1080 x 1920 in portrait mode (9:16).

Constraints:

The value is the pixel value relative to the image layout. It indicates only the layout position relationship and is irrelevant to the resolution of the output image.

Value range:

-1920-3840

Default value:

0

dy

Integer

Details:

Y axis position of the pixel in the upper left corner of the image. The coordinate of the upper left corner of the image layout is 0x0.

The image layout resolution is 1920 x 1080 in landscape mode (16:9) and 1080 x 1920 in portrait mode (9:16).

Constraints:

The value is the pixel value relative to the image layout. It indicates only the layout position relationship and is irrelevant to the resolution of the output image.

Value range:

-1920-3840

Default value:

0

layer_index

Integer

Details:

Layer sequence of an image, video, or person image.

NOTE:

The layer sequence is an integer starting from 1 and incremented by 1.

Constraints:

If duplicate layers exist, the overlay relationship between the duplicate layers is random.

Value range:

1-100

Default value:

100

Table 22 LayerSizeConfig

Parameter

Type

Description

width

Integer

Details:

Y axis position of the pixel in the upper left corner of the image. Width (in pixel) of the layer image (relative to the image layout size).

The image layout resolution is 1920 x 1080 in landscape mode (16:9) and 1080 x 1920 in portrait mode (9:16).

Constraints:

The value is the pixel value relative to the image layout. It indicates only the layout position relationship and is irrelevant to the resolution of the output image.

Value range:

1-7680

height

Integer

Details:

Height (in pixel) of the layer image (relative to the image layout size).

The image layout resolution is 1920 x 1080 in landscape mode (16:9) and 1080 x 1920 in portrait mode (9:16).

Constraints:

The value is the pixel value relative to the image layout. It indicates only the layout position relationship and is irrelevant to the resolution of the output image. |

Value range:

1-7680

Table 23 ImageLayerConfig

Parameter

Type

Description

image_url

String

Details:

Image file URL.

Constraints:

N/A

Options:

The value contains 1 to 2,048 characters.

Default value:

N/A

Table 24 VideoLayerConfig

Parameter

Type

Description

video_url

String

Details:

Video file URL.

Constraints:

N/A

Options:

The value contains 1 to 2,048 characters.

Default value:

N/A

video_cover_url

String

Details:

Video thumbnail file URL.

Constraints:

N/A

Options:

The value contains 1 to 2,048 characters.

Default value:

N/A

loop_count

Integer

Details:

Number of times that a video is played cyclically.

Options:

  • 0: no
  • -1: yes

Constraints:

N/A

Value range:

-1-100

Default value:

-1

Table 25 TextLayerConfig

Parameter

Type

Description

text_context

String

Details:

Text of the text layer. The content must be encoded using Base64.

For example, if you want to add the text watermark "Test text watermark", set text_context to 5rWL6K+V5paH5a2X5rC05Y2w.

Constraints:

N/A

Options:

The value contains 0 to 1,024 characters.

Default value:

N/A

font_name

String

Details:

Font. The following fonts are supported:

Constraints:

N/A

Options:

For details about the supported fonts, see Supported Fonts.

Default value:

HarmonyOS_Sans_SC_Black

font_size

Integer

Details:

Font size (in pixel). The interface value ranges from 0 to 120. The actual value range is 4 to 120. Use the actual value range.

Constraints:

N/A

Value range:

0-120

Default value:

16

font_color

String

Details:

Font color. RGB color value.

Constraints:

N/A

Options:

The value contains 0 to 16 characters.

Default value:

#FFFFFF

Table 26 SubtitleFiles

Parameter

Type

Description

text_subtitle_file

SubtitleFileInfo object

  

audio_subtitle_file

SubtitleFileInfo object

  
Table 27 SubtitleFileInfo

Parameter

Type

Description

subtitle_file_download_url

String

URL for downloading subtitle files.

subtitle_file_upload_url

String

URL for uploading subtitle files.

subtitle_file_state

String

Subtitle file generation status.

  • GENERATING: generating the subtitle file...
  • GENERATE_SUCCEED: subtitle file generated
  • **GENERATE_FAILED: Subtitle file generation failed.

job_id

String

Subtitle file generation task ID.

Table 28 BackgroundMusicConfig

Parameter

Type

Description

music_asset_id

String

Details:

Music asset ID.

Constraints:

N/A

Options:

The value contains 0 to 64 characters.

Default value:

N/A

volume

Integer

Details:

Music volume. For example, 100 indicates that the volume is 100%, and 50 indicates that the volume is 50%.

Constraints:

N/A

Value range:

0-100

Default value:

100

Status code: 400

Table 29 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 30 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 31 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 32 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

GET https://{endpoint}/v1/0d697589d98091f12f92c0073501cd79/2d-digital-human-videos/26f06524-4f75-4b3a-a853-b649a21aaf66

Example Responses

Status code: 200

The information is returned when the request succeeds.

{
  "job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66",
  "state" : "SUCCESS",
  "start_time" : "2022-01-18T16:29:36Z",
  "end_time" : "2022-01-18T16:30:36Z",
  "duration" : 60,
  "output_asset_config" : {
    "asset_id" : "942e65a5fd219a2e01fb08d881cfadb9",
    "asset_name" : "One Day",
    "cover_url" : "https://{endpoint}/0d697589d98091f12f92c0073501cd79/942e65a5fd219a2e01fb08d881cfadb9/20d367508e62d3d4ad608cedbe81bd35.png?AccessKeyId=XCQKTA8IWQPCAUQS4SDA&Expires=1671241457&Signature=zVGMVbI5ji9rr8epD1Cir5OGIRk%3D"
  },
  "error_info" : null,
  "create_time" : "2022-11-30T06:59:56Z",
  "lastupdate_time" : "2022-11-30T07:00:09Z",
  "script_id" : "4b5b6effcf3b4c72a0baccb265111765",
  "model_asset_id" : "cda7e9a469ee9cf3ffc1ad62794a12ff",
  "voice_config" : {
    "voice_asset_id" : "f5e6a13eab4443fa85421191ad061780",
    "speed" : 100,
    "pitch" : 100,
    "volume" : 140
  },
  "video_config" : {
    "codec" : "H264",
    "bitrate" : 5000,
    "width" : 720,
    "height" : 1280,
    "frame_rate" : 30
  },
  "shoot_scripts" : [ {
    "sequence_no" : 0,
    "shoot_script" : {
      "text_config" : {
        "text" : "Hello, everyone. I'm Yunling."
      },
      "background_config" : {
        "background_type" : "IMAGE",
        "background_config" : "https://{endpoint}/0d697589d98091f12f92c0073501cd79/c7885ffdfb347337a890208ca7fd07e3/34534f0262813a6838bdcfb8bc949af6.jpg?AccessKeyId=WTEZCVDFUF3XHXCTPIJ8&Expires=1686901332&Signature=2E7Y7joo2NopBsU8u3iDnf2P9p8%3D"
      },
      "layer_config" : [ {
        "layer_type" : "HUMAN",
        "position" : {
          "dx" : "656,",
          "dy" : "0,",
          "layer_index" : 1
        },
        "size" : {
          "width" : 607.5,
          "height" : 1080
        }
      } ],
      "script_type" : "TEXT"
    }
  } ]
}

Status code: 400

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

Status code: 401

{
  "error_code" : "MSS.00000001",
  "error_msg" : "Unauthorized"
}

Status code: 404

{
  "error_code" : "MSS.00000002",
  "error_msg" : "Not Found"
}

Status code: 500

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

Status Codes

Status Code

Description

200

The information is returned when the request succeeds.

400

Parameters error, including the error code and its description.

401

Authentication is not performed or fails.

404

No content.

500

Internal service error.

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