Help Center/ MetaStudio/ API Reference/ Asset Management/ Digital Asset Management/ Querying Asset Summary
Updated on 2024-07-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Asset Summary

Function

You can query the brief information about multiple specified assets in the media asset library.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/digital-assets/summarys

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'.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

asset_ids

Yes

Array of strings

Indicates the ID of the asset to be queried.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.
Table 5 Response body parameters

Parameter

Type

Description

asset_list

Array of DigitalAssetSummary objects

Assets.
Table 6 DigitalAssetSummary

Parameter

Type

Description

asset_id

String

Asset ID.

asset_name

String

Asset name.

asset_type

String

Asset types.

Public asset type. Options:

  • VOICE_MODEL: timbre model (uploaded only by the system administrator and common tenants can only query it)

  • VIDEO: video file

  • IMAGE: image file

  • PPT: slide file

  • MUSIC: music

  • AUDIO: audio

  • COMMON_FILE: common file

Virtual avatar asset. Options:

  • HUMAN_MODEL_2D: virtual avatar model

  • BUSINESS_CARD_TEMPLET: business card template

3D virtual human asset attribute. Options:

  • HUMAN_MODEL: 3D virtual human model

  • SCENE: scene model

  • ANIMATION: animated actions

  • MATERIAL: stylized materials

  • NORMAL_MODEL: normal model

cover_url

String

Path of the cover image.

thumbnail_url

String

Thumbnail path.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

POST https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/digital-assets/summarys

{
  "asset_ids" : [ "8cb2f48a2cb006154794741933421100", "e2ba8314ebaab34d368711d118fcecba" ]
}

Example Responses

Status code: 200

Successful.

{
  "asset_list" : [ {
    "asset_id" : "93769b5a-c8c6-4692-9c95-53933a1f0c93",
    "asset_name" : "Male Teacher",
    "asset_type" : "HUMAN_MODEL",
    "cover_url" : "https://{endpoint}:443/05a8ae5925000fb72f83c0091083231a/ca40212e1cdb64ab5f74446bcddb8eb9/model/image/6dd0c018-7b8e-46aa-8a45-3075c161c500.png?AccessKeyId=F8DE4LGO7EOYY0CM9ERJ&Expires=1657527524&Signature=BWgSQpc4lMFFrtj2ae67fw679%2Bc%3D"
  } ]
}

Status code: 400

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

Status Codes

Status Code

Description

200

Successful.

400

Parameters error, including the error code and its description.

Error Codes

See Error Codes.

Parent Topic: Digital Asset Management