On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ MetaStudio/ API Reference/ Image Modeling Management/ Creating a Virtual Avatar Model Training Task

Creating a Virtual Avatar Model Training Task

Updated on 2025-02-10 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

Creates a virtual avatar model training task.

Calling Method

For details, see Calling APIs.

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	Contact of the virtual avatar training task creator, for example, mobile number or email address.
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. By default, the V3 model is used. V2: V2 model V3: V3 model V3.2: V3.2 model NOTE: V2 has been discarded. Value range: 0-64 Default value: V3.2
is_flexus	No	Boolean	Whether the image training is of the basic edition 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
supported_service	No	Array of strings	Service types supported by the model generated by the task. You can select multiple service types. Default value: [VIDEO_2D,LIVE_2D]

**Table 4** VoiceProperties
Parameter	Mandatory	Type	Description
job_tag	Yes	String	Task tag. ECOMMERCE NEWS MARKETING
sex	Yes	String	Voice gender, which can be male or female. FEMALE MALE Default value: FEMALE
language	Yes	String	Training language. 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 after the file is uploaded. The file can be uploaded only once. Note: The video must be in MP4 format with 1080P or 4K resolution (horizontal or portrait). The video length must range from 3 minutes to 10 minutes. Otherwise, the review will fail.
action_video_upload_url	Array of strings	URL for uploading a virtual avatar training video. The URL becomes invalid after the file is uploaded. The file can be uploaded only once. Note: The video must be in MP4 format with 1080p or 4K resolution (horizontal or portrait). The video length must range from 3 minutes to 10 minutes.
audio_upload_url	String	URL for uploading audio data for training. The URL becomes invalid after the file is uploaded. The file can be uploaded only once.
cover_upload_url	String	URL for uploading a model thumbnail. The URL becomes invalid after the file is uploaded. The file can be uploaded only once.
id_card_image1_upload_url	String	URL for uploading the ID card front-side photo. The URL becomes invalid after the file is uploaded. The file can be uploaded only once. Note: Non-NA users must upload the file. Otherwise, the review will fail.
id_card_image2_upload_url	String	URL for uploading the ID card back-side photo. The URL becomes invalid after the file is uploaded. The file can be uploaded only once. Note: Non-NA users must upload the file. Otherwise, the review will fail.
grant_file_upload_url	String	URL for uploading the authorization letter. The URL becomes invalid after the file is uploaded. The file can be uploaded only once. Note: Non-NA users must upload the file. Otherwise, the review will fail.

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

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

Status code: 500

{
  "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.

Error Codes

See Error Codes.

Parent Topic: Image Modeling Management

Previous topic: Image Modeling Management

Next topic: Querying Virtual Avatar Model Training Tasks

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot