Help Center/ MetaStudio/ API Reference/ Image Modeling Management/ Querying Details About a Virtual Avatar Model Training Task

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

Online Debugging

CLI Examples

View PDF

Querying Details About a Virtual Avatar Model Training Task

Function

Queries details of a virtual avatar model training task.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/digital-human-training-manage/user/jobs/{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.

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.

Response Parameters

Status code: 200

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

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Task ID.
name	String	Virtual avatar model name, which is used as its name in the asset library.
state	String	Task status. Options: WAIT_FILE_UPLOAD: to upload files AUTO_VERIFYING: auto reviewing... AUTO_VERIFY_FAILED: Auto review failed. MANUAL_VERIFYING: manually reviewing... WAIT_TRAINING_DATA_PREPROCESS: waiting for training data preprocessing... MANUAL_VERIFY_FAILED: Manual review failed. MANUAL_VERIFY_SUCCESS: approved and waiting for resource preprocessing TRAINING_DATA_PREPROCESSING: preprocessing training data... TRAINING_DATA_PREPROCESS_FAILED: Training data preprocessing failed. TRAINING_DATA_PREPROCESS_SUCCESS: training data preprocessed and waiting for resource training TRAINING: training... TRAIN_FAILED: Training failed. TRAIN_SUCCESS: training completed and waiting for resource preprocessing INFERENCE_DATA_PREPROCESSING: preprocessing inference data... INFERENCE_DATA_PREPROCESS_FAILED: Inference data preprocessing failed. WAIT_MASK_UPLOAD: waiting for mask upload... WAIT_MAIN_FILE_UPLOAD: waiting for main file upload... JOB_SUCCESS: training task completed MANUAL_STOP_INFERENCE_DATA_PREPROCESS: manually stop inference preprocessing MANUAL_STOP_TRAIN: manually stop training MANUAL_STOP_TRAINING_DATA_PREPROCESS: manually stop training preprocessing WAIT_USER_CONFIRM: waiting for the user to confirm the training result... JOB_REJECT: task rejected JOB_PENDING: task suspended WAIT_ADMIN_CONFIRM: The task is waiting for the administrator to review. JOB_FINISH: The task is complete and the status cannot be changed. COMPILING: compiling... WAIT_COMPILE: waiting for compilation... COMPILE_FAILED: Compilation failed. WAIT_GENERATE_ACTION: waiting for generating an atomic action... WAIT_ARRANGE: waiting for choreography... ACTION_GENERATE_DATA_PROCESSING: generating an atomic action... MANUAL_STOP_ACTION_GENERATE_DATA_PROCESSING: manually terminate action generation MANUAL_STOP_ACTION_GENERATE_ORI_PROCESSING: manually terminate choreography ACTION_GENERATE_ORI_PROCESSING: choreographing... ACTION_GENERATE_DATA_FAILED: Action generation failed. ACTION_GENERATE_ORI_FAILED: Generating the asset for choreography failed. ACTION_GENERATE_ORI_SUCCESS: Choreography succeeded. GENERATE_ACTION_PREPROCESS_FAILED: Generating the atomic action for choreography failed. WAIT_ADMIN_CALIBRATION**: waiting for the administrator to confirm the action...
asset_id	String	Model asset ID.
project_id	String	Project ID of a model asset.
cover_download_url	String	URL for downloading the virtual avatar model thumbnail. The URL is valid for 24 hours.
last_update_time	String	Indicates the last time when a user updates a task (for example, creates or resubmits a task). The format complies with RFC 3339, for example, 2020-07-30T10:43:17Z.
create_time	String	Creation time. The format complies with RFC 3339, for example, 2020-07-30T10:43:17Z.
contact	String	Contact of the virtual avatar training task creator, for example, mobile number or email address.
batch_name	String	Batch name of virtual avatar training tasks.
tags	Array of strings	Tag of a virtual avatar training task.
model_version	String	Virtual avatar model version. The default value is V3. V2: V2 model V3: V3 model Value range: 0-64 Default value: V3.2
matting_type	String	Matting type. The default value is AI. AI: AI matting MANUAL: manual matting Default value: AI
model_resolution	String	Virtual avatar model resolution. The default value is 1080P. 1080P: supports 1080P and 720P video output. 4K: supports 4K, 1080P, and 720P video output. Default value: 1080P
app_user_id	String	Customized user ID. This parameter is carried if X-App-UserId is set during task creation.
is_flexus	Boolean	Whether the image training is of the basic edition
training_video_download_url	String	URL for downloading the virtual avatar training video. The URL is valid for 24 hours.
id_card_image1_download_url	String	URL for downloading the ID card front-side photo. The URL is valid for 24 hours.
id_card_image2_download_url	String	URL for downloading the ID card back-side photo. The URL is valid for 24 hours.
grant_file_download_url	String	URL for downloading the authorization letter. The URL is valid for 24 hours.
action_video_download_url	String	Action video
audio_file_download_url	String	URL for downloading an audio file.
operation_logs	Array of OperationLogInfo objects	Operation logs.
verify_video_matting_info	Array of VerifyVideoMattingInfo objects	Non-cropped area when the crop verification video is being generated.
comment_logs	Array of CommentLogInfo objects	Comment logs.
samples	Array of ActionSampleInfo objects	Action video sample.
is_mask_file_uploaded	Boolean	Indicates whether the mask file is uploaded.
mask_file_download_url	String	URL for downloading the mask. The URL is valid for 24 hours.
verify_video_download_url	String	URL for downloading the video to be reviewed.
markable_video_download_url	String	URL for downloading the tagged video. The URL is valid for 24 hours.
inference_data_process_video_mark_info	InferenceVideoMarkInfo object	Information of virtual avatar inference preprocessing video tag.
inference_data_process_action_mark_info	InferenceActionMarkInfo object	Information of virtual avatar inference preprocessing action tag.
inference_data_process_eye_correction_mark_info	InferenceEyeCorrectionMarkInfo object	Information of virtual avatar inference preprocessing video tag.
is_background_replacement	Boolean	Indicates whether to replace the background for a virtual avatar. If yes, training videos require green-screen shooting. Default value: true
worker_type	Array of strings	Compilation task model.
voice_train_job_id	String	Voice training task ID.
flexus_retry_count	Integer	Number of remaining retraining times of a Flexus task. The value decreases by 1 each time the task is retrained. When the value decreases to 0, the task cannot be retrained. Value range: 0-10
audio_source_type	String	Audio source. VIDEO: audio extracted from a video AUDIO: audio uploaded separately
supported_service	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 5** OperationLogInfo
Parameter	Type	Description
operate_time	String	Operation time. The format complies with RFC 3339, for example, 2020-07-30T10:43:17Z.
log_type	String	Command output. USER_CREATE_JOD: Virtual avatar customization started. USER_VERIFYING_SUBMITTED: video submitted for review SYSTEM_VERIFY_FAILED: Auto review failed. SYSTEM_VERIFY_SUCCESS: Auto review succeeded. ADMIN_VERIFY_SUCCESS: Manually approved. ADMIN_VERIFY_FAILED: Manual review failed. SYSTEM_TRAIN_DATA_PREPROCESSING: preprocessing training data... SYSTEM_TRAIN_DATA_PREPROCESS_FAILED: Preprocessing training data failed. SYSTEM_TRAIN_DATA_PREPROCESS_SUCCESS: training data preprocessed SYSTEM_ACTION_GENERATE_DATA_PREPROCESSING: generating the atomic action for choreography... SYSTEM_ACTION_GENERATE_DATA_SUCCESS: atomic action for choreography generated SYSTEM_ACTION_GENERATE_ORI_SUCCESS: choreography asset data generated SYSTEM_ACTION_GENERATE_DATA_FAILED: Generating the atomic action for choreography failed. SYSTEM_ACTION_GENERATE_ORI_FAILED: Generating the choreography asset data failed. SYSTEM_ACTION_GENERATE_ORI_PREPROCESSING: generating the choreography asset data... SYSTEM_TRAINING: Training started. ADMIN_STOP_TRAINING_DATA_PREPROCESS: manually stop training ADMIN_STOP_INFERENCE_DATA_PREPROCESS: manually stop inference preprocessing ADMIN_STOP_TRAIN: manually terminate training SYSTEM_TRAIN_FAILED: Training failed. SYSTEM_TRAIN_SUCCESS: Training succeeded. SYSTEM_INFERENCE_DATA_PREPROCESSING: preprocessing inference data... SYSTEM_INFERENCE_DATA_PREPROCESS_FAILED: Inference data preprocessing failed. SYSTEM_INFERENCE_DATA_PREPROCESS_SUCCESS: inference data preprocessed SYSTEM_JOB_SUCCESS: task completed ADMIN_MASK_UPLOADED: mask file uploaded (discarded) ADMIN_UPDATE_VIDEO: video replacement by administrator ADMIN_UPDATE_ACTION_VIDEO: replacement of the video for choreography by administrator ADMIN_RESET: one-click reset by administrator ADMIN_ACCEPT: approved by administrator USER_REPAIR: user repairing SYSTEM_UPDATE_COVER: change the thumbnail ADMIN_SET_SILENCE_REPEAT_NUM: number of silent rounds set by administrator SYSTEM_MARKABLE_VIDEO: generate a labeling video SYSTEM_MASK_VERIFY_VIDEO: generate a verification video SYSTEM_MASK_VERIFY_VIDEO_SUCCESS: verification video generated SYSTEM_MASK_VERIFY_VIDEO_FAILED: Verification video generation failed. SYSTEM_MARKABLE_VIDEO_SUCCESS: labeling video generated ADMIN_CONFIRM_ACTION: The administrator confirms the action. ADMIN_STOP_ACTION_GENERATE_DATA_PREPROCESS: manually terminate atomic action generation ADMIN_STOP_ACTION_GENERATE_ORI_PREPROCESS: manually terminate choreography SYSTEM_COMPILE_FAILED: Compilation failed. SYSTEM_COMPILE_SUCCESS: Compilation succeeded. SYSTEM_MARKABLE_VIDEO_FAILED: Labeling video generation failed. ADMIN_UPDATE_COMPILE: The administrator updates the compilation configuration. ADMIN_UPDATE_INFERENCE_DATA_PROCESS_VIDEO: The administrator updates the time segment information in the inference preprocessing. SYSTEM_EXECUTE_COMPILE: execute compilation SYSTEM_MASK_VIDEO_AND_ACTION_TIME_SUCCESS: auto labeled SYSTEM_MASK_VIDEO_AND_ACTION_TIME_FAILED: Auto labeling failed. USER_UPDATE_VIDEO: video update by the user ADMIN_UPDATE_GENERAL_CONFIG: The administrator updates the common configuration. ADMIN_MASK_ACTION_TIME: labeling by administrator STOP_COMPILE: manually terminate compilation
log_description	String	Log description, covering review comments if the manual review failed and error messages reported by the DHTS and DHPS.
operate_user	String	Operators. Options: USER ADMIN SYSTEM

**Table 6** VerifyVideoMattingInfo
Parameter	Type	Description
dx	Integer	X-axis position of the pixel in the upper left corner of the area. Value range: 0-3840
dy	Integer	Y-axis position of the pixel in the upper left corner of the area. Value range: 0-3840
width	Integer	Area width (pixels). Value range: 1-7680
height	Integer	Area height (pixels). Value range: 1-7680
method	String	Resource operation. Options: RESERVED: video area that does not need to be cropped DELETE: video area that needs to be cropped NO_DEGREEN: video area that does not need degreening

**Table 7** CommentLogInfo
Parameter	Type	Description
operate_time	String	Operation time. The format complies with RFC 3339, for example, 2020-07-30T10:43:17Z.
comment_type	String	USER_REJECT: Rejection by user. USER_COMMENT: User comments. ADMIN_COMMENT: Administrator's reply.
comment_title	String	Title.
comment_message	String	Message.
attachment_download_url	Array of strings	URL for downloading the attachment.

**Table 8** ActionSampleInfo
Parameter	Type	Description
action_name_zh	String	Atomic action name in Chinese.
action_name_en	String	Atomic action name in English.
action_tag	String	Action tag.
catalog	String	Action category name.
is_selected	Boolean	Whether to select this action. Default value: true
sample_download_url	String	URL for downloading the atomic action sample file. Valid within 24 hours.

**Table 9** InferenceVideoMarkInfo
Parameter	Type	Description
video_start_time	String	Start time of the inference preprocessing video. Format: HH:MM:SS.mmm.
video_end_time	String	End time of the inference preprocessing video. Format: HH:MM:SS.mmm.

**Table 10** InferenceActionMarkInfo
Parameter	Type	Description
action_info	Array of ActionMarkItem objects	Actions.

**Table 11** ActionMarkItem
Parameter	Type	Description
action_start_time	String	Start time of the inference preprocessing video. Format: HH:MM:SS.mmm.
action_end_time	String	End time of the inference preprocessing video. Format: HH:MM:SS.mmm.
action_type	String	Action type. Options: SILENCE ACTION Value range: 0-64

**Table 12** InferenceEyeCorrectionMarkInfo
Parameter	Type	Description
eye_correction_start_time	String	Select the start time of inference preprocessing for eye contact correction. Format: HH:MM:SS.mmm.
eye_correction_end_time	String	Select the end time of inference preprocessing for eye contact correction. Format: HH:MM:SS.mmm.

Status code: 400

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

Status code: 500

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

Example Requests

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

Example Responses

Status code: 200

The information is returned when the request succeeded.

{
  "job_id" : "efc5300ecdba4ea48d1ff13a9d907bc0",
  "name" : "Test Name",
  "state" : "MANUAL_VERIFYING",
  "project_id" : "***",
  "cover_download_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_cover?param1=XXX&param2=YYY",
  "create_time" : "2023-12-09T07:31:37Z",
  "contact" : "1**********",
  "model_version" : "V3",
  "matting_type" : "AI",
  "model_resolution" : "1080P",
  "training_video_download_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_trainingVideo?param1=XXX&param2=YYY",
  "id_card_image1_download_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_idCardImage1?param1=XXX&param2=YYY",
  "id_card_image2_download_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_idCardImage2?param1=XXX&param2=YYY",
  "grant_file_download_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_grantFile?param1=XXX&param2=YYY",
  "operation_logs" : [ {
    "operate_time" : "2023-12-09T07:31:37Z",
    "log_type" : "USER_CREATE_JOD",
    "operate_user" : "USER"
  }, {
    "operate_time" : "2023-12-09T07:31:43Z",
    "log_type" : "SYSTEM_MARKABLE_VIDEO",
    "operate_user" : "SYSTEM"
  }, {
    "operate_time" : "2023-12-09T07:31:43Z",
    "log_type" : "USER_VERIFYING_SUBMITTED",
    "operate_user" : "USER"
  }, {
    "operate_time" : "2023-12-09T07:31:43Z",
    "log_type" : "SYSTEM_VERIFY_SUCCESS",
    "operate_user" : "SYSTEM"
  }, {
    "operate_time" : "2023-12-09T07:32:45Z",
    "log_type" : "SYSTEM_MARKABLE_VIDEO_SUCCESS",
    "operate_user" : "SYSTEM"
  } ],
  "comment_logs" : [ ],
  "is_mask_file_uploaded" : false,
  "verify_video_download_url" : "null",
  "markable_video_download_url" : "https://example.com/efc5300ecdba4ea48d1ff13a9d907bc0_markableData?param1=XXX&param2=YYY",
  "is_background_replacement" : true
}

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.