CreateAvatarTrainingJob-阿里云帮助中心

Operation description

This operation only initializes the training task information and does not submit the training. To formally submit the training, call the SubmitAvatarTrainingJob operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:CreateAvatarTrainingJob

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AvatarName	string	Yes	The name of the digital human. The name can be up to 7 characters in length.	Decimal
AvatarDescription	string	No	The description of the digital human. The description can be up to 1000 characters in length.	This is a digital human used for a specific scenario.
AvatarType	string	No	The type of the digital human.	2DAvatar
Thumbnail	string	No	The thumbnail URL. After training succeeds, the thumbnail is uploaded to this address. The URL must be a valid public OSS URL under the current user. The URL can be up to 512 characters in length.	https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png
Portrait	string	No	The media asset ID of the avatar image. The ID is 32 characters in length. If you subsequently call SubmitAvatarTrainingJob to submit the training, this field is required. The image must have equal width and height.	**571c704445f9a0ee011406c2**
Video	string	No	The media asset ID of the training video. The ID is 32 characters in length. Supported formats: mp4, mov, and webm. The duration of the material must be between 5 minutes and 15 minutes. The resolution of the material must be 1920 × 1080 or 1080 × 1920. If you subsequently call SubmitAvatarTrainingJob to submit the training, this field is required.	**571c704445f9a0ee011406c2**
Transparent	boolean	No	Specifies whether the training video supports a transparent channel. Important Make sure that this setting is consistent with the submitted training video. Otherwise, the synthesized digital human may be abnormal.	True

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
Success	boolean	Indicates whether the request was successful.	true
Data	object	The response data.
JobId	string	The ID of the digital human training task.	**d718e2ff4f018ccf419a7b71**

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.