Help Center/ MetaStudio/ API Reference/ Image Modeling Management/ Executing a Virtual Avatar Model Training Task as a Tenant
Updated on 2024-07-04 GMT+08:00

Executing a Virtual Avatar Model Training Task as a Tenant

Function

Executes a virtual avatar model training task as a tenant, for example, submitting training videos for review.

Calling Method

For details, see Calling APIs.

URI

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

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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

command

Yes

String

Command type. Options:

  • SUBMITVERIFYING: A video is submitted for review.

  • CONFIRM_ACCEPT: User confirms the training result.

  • CONFIRM_REJECT: User rejects the training result.

  • CONFIRM_ANSWER: User reply.

  • CONFIRM_PENDING: User pends a task.

  • CONFIRM_ACTIVE: User activates a task.

  • GET_MULTIPART_UPLOADED: Information about uploaded parts has been obtained.

  • CONFIRM_MULTIPART_UPLOADED: All video parts have been uploaded.

NOTE:
  • CONFIRM_ACCEPT, CONFIRM_REJECT, CONFIRM_ANSWER, CONFIRM_PENDING, and CONFIRM_ACTIVE commands are available only for NA users.

command_message

No

String

Command type. Options:

  • UPDATE_VIDEO: Updating a video.

  • UPLOAD_VIDEO: Uploading a video.

comment_data

No

CommentData object

Comment data.

Table 4 CommentData

Parameter

Mandatory

Type

Description

comment_title

No

String

Title.

comment_message

No

String

Message.

attachment_name

No

Array of strings

Attachment name.

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

commond_result

String

Command execution result. Options:

  • EXCUTE_SUCCESS: Command execution succeeded.

  • EXCUTE_FAILED: Command execution failed.

attachment_upload_url

Array of strings

URL for uploading the attachment.

multipart_data

Array of MultipartUploadInfo objects

Information of the uploaded parts of the training video.

Table 7 MultipartUploadInfo

Parameter

Type

Description

part_number

String

Part number.

etag

String

Part file tag.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 9 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/command

{
  "command" : "CONFIRM_MULTIPART_UPLOADED"
}

Example Responses

Status code: 200

The information is returned when the request succeeded.

{
  "commond_result" : "EXCUTE_SUCCESS"
}

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.