All Products
Search
Document Center

Intelligent Media Services:CreateAvatarTrainingJob

Last Updated:Dec 16, 2024

Creates a digital human training job. You can configure the basic information of the digital human and the materials required for the training. Note: This operation is used to initialize the training job. It does not submit the training job. To submit the training job, call the SubmitAvatarTrainingJob operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ice:CreateAvatarTrainingJobcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AvatarNamestringYes
  • The name of the digital human.
  • The name can be up to seven characters in length.
AvatarDescriptionstringNo
  • The description of the digital human.
  • The description can be up to 1,000 characters in length.
AvatarTypestringNo

The type of the digital human.

2DAvatar
ThumbnailstringNo
  • The thumbnail URL.
  • After the digital human is trained, the thumbnail is uploaded to this URL.
  • The URL must be a valid public Object Storage Service (OSS) URL.
  • The URL can be up to 512 characters in length.
https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png
PortraitstringNo
  • The media asset ID of the portrait image.
  • The value must be 32 characters in length.
****571c704445f9a0ee011406c2****
VideostringNo
  • The ID of the video used for training.
  • The value must be 32 characters in length.
  • Supported formats: MP4, MOV, and WebM.
  • The duration of the video must be 5 to 15 minutes.
  • The resolution of the video must be 1920×1080 or 1080×1920.
****571c704445f9a0ee011406c2****
TransparentbooleanNo
  • Specifies whether the training video supports alpha channels.

    **

    Note: Make sure that the current settings are consistent with those of the submitted training video. Otherwise, the digital human may malfunction.

True

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

Indicates whether the request was successful.

true
Dataobject

The data returned.

JobIdstring

The ID of the digital human training job.

****d718e2ff4f018ccf419a7b71****

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Success": true,
  "Data": {
    "JobId": "****d718e2ff4f018ccf419a7b71****"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-17The request parameters of the API has changedView Change Details