Help Center/ MetaStudio/ API Reference/ Virtual Avatar Video Production/ Video Script Management/ Querying Video Scripts
Updated on 2024-07-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Video Scripts

Function

Queries video scripts.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/digital-human-video-scripts

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset where the query starts.

limit

No

Integer

Number of items displayed on each page.

name

No

String

Fuzzy search by name.

script_catalog

No

String

Script type. By default, VIDEO_DRAFT is queried.

  • VIDEO_DRAFT: video draft

  • SYSTEM_VIDEO_TEMPLET: system video template

view_mode

No

String

Landscape or portrait mode (internal parameter). The default value is LANDSCAPE.

  • LANDSCAPE: landscape

  • VERTICAL: portrait

Request Parameters

Table 3 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 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.
Table 5 Response body parameters

Parameter

Type

Description

count

Integer

Total number of scripts.

video_scripts

Array of VideoScriptBaseInfo objects

Script list.
Table 6 VideoScriptBaseInfo

Parameter

Type

Description

script_id

String

Script ID.

script_name

String

Script name.

script_description

String

Script description.

model_asset_id

String

Asset ID of a virtual human model.

model_asset_type

String

Virtual human model type.

  • HUMAN_MODEL_2D: virtual avatar

  • HUMAN_MODEL_3D: 3D virtual human

script_cover_url

String

URL for downloading the script thumbnail.

script_type

String

Script type, that is, the control mode of video production. The default value is TEXT.

TEXT: text control, that is, voice compositing through TTS

AUDIO: speech control

text

String

Script.

create_time

String

Creation time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

update_time

String

Update time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

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

GET https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-video-scripts

Example Responses

Status code: 200

Succeeded.

{
  "count" : 1,
  "video_scripts" : [ {
    "script_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66",
    "script_name" : "The Legend of Nature",
    "model_asset_id" : "a5d295cdb345c11bd9f36bc22ced3a7a",
    "script_description" : "Courseware",
    "create_time" : "2022-11-30T06:59:55Z",
    "update_time" : "2022-12-05T12:30:37Z"
  } ]
}

Status code: 400

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

Status code: 401

{
  "error_code" : "MSS.00000001",
  "error_msg" : "Unauthorized"
}

Status code: 500

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

Status Codes

Status Code

Description

200

Succeeded.

400

Parameters error, including the error code and its description.

401

Authentication is not performed or fails.

500

Internal service error.

Error Codes

See Error Codes.

Parent Topic: Video Script Management