Help Center/ MetaStudio/ API Reference/ Virtual Avatar Livestreaming/ Live Product Management/ Configuring a Product Asset Portfolio
Updated on 2024-07-05 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Configuring a Product Asset Portfolio

Function

Configures a product asset portfolio.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/products/{product_id}/assets

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.

product_id

Yes

String

Product 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

asset_item

No

ProductMediaInfo object

Product material information

text_item

No

ProductTextInfo object

Product text

action

No

String

Adds or deletes asset associations. - LINK: manages assets - UNLINK: cancels asset management
Table 4 ProductMediaInfo

Parameter

Mandatory

Type

Description

asset_id

No

String

Asset ID

asset_type

No

String

Asset type. Options:

  • IMAGE: image

  • VIDEO: video

  • AUDIO: audio

order

No

Integer

Asset sequence. If this parameter is not specified or is set to 0, assets are sorted by creation time. The image on top of the list is set as the product thumbnail.
Table 5 ProductTextInfo

Parameter

Mandatory

Type

Description

title

No

String

Text title

text

No

String

Text

Response Parameters

Status code: 200

Table 6 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID

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

POST https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/digitalhumans/24bad716-87b1-45e5-8912-6102f7693265/assets

{
  "action" : "LINK",
  "asset_item" : {
    "asset_id" : "24bad716-87b1-45e5-8912-6102f7693265"
  }
}

Example Responses

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

Virtual human asset set.

400

Parameters error, including the error code and its description.

500

Internal service error.

Error Codes

See Error Codes.

Parent Topic: Live Product Management