Creating a Virtual Avatar Model Training Task

Function

Creates a virtual avatar model training task.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v1/{project_id}/digital-human-training-manage/user/jobs

**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-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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Virtual avatar model name, which is used as its name in the asset library.
contact	No	String	Mobile number of the creator of the virtual avatar training task.
command_message	No	String	Command type. Options: UPDATE_VIDEO: updating a video UPLOAD_VIDEO: uploading a video CONFIRM_ACTION_VIDEO: confirming the video for choreography GET_ACTION_VIDEO_MULTIPART: obtaining segments of the video for choreography Value range: 0~64 Default value: UPLOAD_VIDEO
video_multipart_count	No	Integer	Number of uploaded training video segments (These segments are uploaded concurrently, not separately.) Value range: 1~1000 Default value: 1
action_video_multipart_count	No	Integer	Number of uploaded action video segments. Value range: 1~1000 Default value: 1
is_background_replacement	No	Boolean	Indicates whether to replace the background for a virtual avatar. If yes, training videos require green-screen shooting. Default value: true
batch_name	No	String	Batch name of virtual avatar training tasks.
tags	No	Array of strings	Tag of a virtual avatar training task.
model_version	No	String	Virtual avatar model version. The default version is V3.2. V3.2: V3.2 model V3.3: training model for the ultra-fast Flexus edition NOTE: V3 and V2 have been deprecated. Value range: 0~64 Default value: V3.2
is_ondemand_resource	No	Boolean	Type of a virtual avatar training task. true: on-demand task false: common task Default value: false
is_flexus	No	Boolean	Whether the image training is of the basic edition Default value: false
is_fast_flexus	No	Boolean	Whether it is an ultra-fast Flexus edition. Default value: false
is_live_copy	No	Boolean	Whether it is a task for training a livestream-based avatar. Default value: false
is_only_human_model	No	Boolean	Whether to train the image model but not the voice model. This parameter is valid only for Flexus. The default value is false. Default value: false
audio_source_type	No	String	Audio source. VIDEO: audio extracted from a video AUDIO: audio uploaded separately Default value: VIDEO
voice_properties	No	VoiceProperties object	Voice configuration, which is a configuration item of the Flexus edition. The standard edition does not support this configuration item.
supported_service	No	Array of strings	Service types supported by the model generated by the task. You can select multiple service types. Flexus virtual avatars support only VIDEO_2D. Default value: [VIDEO_2D,LIVE_2D]

**Table 4** VoiceProperties
Parameter	Mandatory	Type	Description
job_tag	Yes	String	Task tag, which is a configuration item of the Flexus edition. ECOMMERCE NEWS MARKETING
sex	Yes	String	Voice gender, which is a configuration item of the Flexus edition. FEMALE MALE Default value: FEMALE
language	Yes	String	Training language, which is a configuration item of the Flexus edition. Currently, only Chinese is supported. CN: Chinese EN: English

Response Parameters

Status code: 200

**Table 5** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 6** Response body parameters
Parameter	Type	Description
job_id	String	Task ID.
training_video_upload_url	Array of strings	URL for uploading a virtual avatar training video. The URL becomes invalid once the file is uploaded once. Note: The video must be in MP4 format with 1080p or 4K resolution (landscape or portrait). The video length must range from 3 minutes to 10 minutes. NOTE: Set content-type to application/octet-stream when uploading a file using the URL.
action_video_upload_url	Array of strings	URL for uploading a virtual avatar training video. The URL becomes invalid once the file is uploaded once. Note: The video must be in MP4 format with 1080p or 4K resolution (landscape or portrait). The video length must range from 3 minutes to 10 minutes. NOTE: Set content-type to application/octet-stream when uploading a file using the URL.
audio_upload_url	String	URL for uploading audio data for training. The URL becomes invalid once the file is uploaded once. NOTE: Set content-type to application/zip when uploading a file using the URL.
cover_upload_url	String	URL for uploading a model thumbnail. The URL becomes invalid once the file is uploaded once. NOTE: Set content-type to application/octet-stream when uploading a file using the URL.
id_card_image1_upload_url	String	URL for uploading the ID card front-side photo. The URL becomes invalid once the file is uploaded once. Note: Non-NA users must upload the file. Otherwise, the review will fail. NOTE: Set content-type to application/octet-stream when uploading a file using the URL.
id_card_image2_upload_url	String	URL for uploading the ID card back-side photo. The URL becomes invalid once the file is uploaded once. Note: Non-NA users must upload the file. Otherwise, the review will fail. NOTE: Set content-type to application/octet-stream when uploading a file using the URL.
grant_file_upload_url	String	URL for uploading the authorization letter. The URL becomes invalid once the file is uploaded once. Note: Non-NA users must upload the file. Otherwise, the review will fail. NOTE: Set content-type to application/octet-stream when uploading a file using the URL.
pre_beauty_image_upload_url	String	URL for uploading the pre-brightening image. NOTE: Set content-type to application/octet-stream when uploading a file using the URL.
post_beauty_image_upload_url	String	URL for uploading the brightened image. NOTE: Set content-type to application/octet-stream when uploading a file using the URL.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

https://example.com/rest/v1/***/digital-human-training-manage/user/jobs

{
  "name" : "Test Role",
  "contact" : "1**********",
  "video_multipart_count" : 2,
  "is_background_replacement" : true
}

Example Responses

Status code: 200

The information is returned when the request succeeded.

{
  "job_id" : "efc5300ecdba4ea48d1ff13a9d907bc0",
  "training_video_upload_url" : [ "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_trainingVideo?parma1=XXX&param2=YYY", "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_trainingVideo?parma1=XXX&param2=YYY" ],
  "cover_upload_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_cover?parma1=XXX&param2=YYY",
  "id_card_image1_upload_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_idCardImage1_tmp?parma1=XXX&param2=YYY",
  "id_card_image2_upload_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_idCardImage2_tmp?parma1=XXX&param2=YYY",
  "grant_file_upload_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_grantFile_tmp?parma1=XXX&param2=YYY"
}

Status code: 400

Parameters error, including the error code and its description.

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

Status code: 500

Internal service error.

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

Status Codes

Status Code	Description
200	The information is returned when the request succeeded.
400	Parameters error, including the error code and its description.
500	Internal service error.